Skip to content

Instantly share code, notes, and snippets.

@rdiehl

rdiehl/swagger.json Secret

Created September 9, 2015 13:39
Show Gist options
  • Save rdiehl/55630bd808c743237417 to your computer and use it in GitHub Desktop.
Save rdiehl/55630bd808c743237417 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
swagger.json
This file has been truncated, but you can view the full file.
{
"swagger": "2.0",
"info": {
"version": "0.0.0.0",
"description": "DocFinity ECM and BPM",
"title": "DocFinity"
},
"basePath": "/docfinity/webservices/rest",
"tags": [
{
"name": "login"
},
{
"name": "faxes"
},
{
"name": "dashboards"
},
{
"name": "systemtransfer"
},
{
"name": "exporteradmin"
},
{
"name": "repository"
},
{
"name": "editing"
},
{
"name": "license"
},
{
"name": "dbconn"
},
{
"name": "importer"
},
{
"name": "ldap"
},
{
"name": "systemproperties"
},
{
"name": "form"
},
{
"name": "dashboarddesigner"
},
{
"name": "document"
},
{
"name": "groups"
},
{
"name": "permissions"
},
{
"name": "search"
},
{
"name": "scansetting"
},
{
"name": "paperclip"
},
{
"name": "exporter"
},
{
"name": "email"
},
{
"name": "validator"
},
{
"name": "records"
},
{
"name": "overlays"
},
{
"name": "printers"
},
{
"name": "macros"
},
{
"name": "indexing"
},
{
"name": "metadataValue"
},
{
"name": "servers"
},
{
"name": "auditing"
},
{
"name": "clipboard"
},
{
"name": "datastore"
},
{
"name": "storedprocedure"
},
{
"name": "formdesigner"
},
{
"name": "metadata"
},
{
"name": "log"
},
{
"name": "usersettings"
},
{
"name": "printfax"
},
{
"name": "datasources"
},
{
"name": "user"
},
{
"name": "documentType"
},
{
"name": "hotkeys"
},
{
"name": "bpmclient"
},
{
"name": "indexingconfig"
},
{
"name": "hsm"
},
{
"name": "bpmmanagement"
},
{
"name": "wsdlurl"
},
{
"name": "category"
},
{
"name": "docsecurity"
}
],
"paths": {
"/dashboarddesigner/dash/bychart": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The chart ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get all dashboards that contain the specified chart, as a top level chart or a drilldown.",
"operationId": "getDashboardsForChart"
}
},
"/auditing/validate": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires the AUDITING_MANAGE feature right.",
"parameters": [
{
"description": "The ID of the audit message to validate.",
"required": false,
"type": "string",
"name": "auditMessageId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"auditing"
],
"summary": "Validate the audit message integrity.",
"consumes": [
"application/json"
],
"operationId": "validateHash"
}
},
"/printers": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the PRINTFAX_MANAGE_DEVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"description": "An array of printers to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"printers"
],
"summary": "Add a printer.",
"consumes": [
"application/json"
],
"operationId": "addPrintersRest"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the PRINTFAX_MANAGE_DEVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"description": "An array of printers to update",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"printers"
],
"summary": "Update an existing printer.",
"consumes": [
"application/json"
],
"operationId": "updatePrintersRest"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the PRINTFAX_MANAGE_DEVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"description": "The printers to be deleted.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"printers"
],
"summary": "Delete the specified printers.",
"consumes": [
"application/json"
],
"operationId": "deletePrintersRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the PRINTFAX_MANAGE_DEVICES feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"printers"
],
"summary": "Gets all printer devices that exist in the system.",
"operationId": "getAllPrintersRest"
}
},
"/hotkeys": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A representation of the HotKey entity for use by the web service layer."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"hotkeys"
],
"summary": "Get a list of all Hot keys.",
"operationId": "getAll"
}
},
"/servers/nodes": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ServerNodeDTO"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"servers"
],
"summary": "Returns all the server nodes configured in the system.",
"operationId": "getAllServerNodes"
}
},
"/dashboarddesigner/groups/not": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for groups."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The start index.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The number of results to return.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "The dashboard ID.",
"required": false,
"type": "string",
"name": "dashboardId",
"in": "query"
},
{
"description": "Any sorts to apply to the groups.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "Any filters to apply to the groups.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get a listing of groups that are not currently assigned to a dashboard.",
"consumes": [
"application/json"
],
"operationId": "getGroupsNotAssignedToDashboardRest"
}
},
"/bpm/management/views": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: BPM_QUEUE_VIEWS_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/View data used to configure job views for the system."
},
"type": "array"
},
"description": "The job views to be deleted",
"required": false,
"name": "viewDtos",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Delete the job views.",
"consumes": [
"application/json"
],
"operationId": "deleteViewsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the following feature right: BPM_QUEUE_VIEWS_CONFIGURE, SYSTEM_TRANSFER_EXPORT",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use. Supports : name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports id(multiple), name(multiple), excludeNames(multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Get job views using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getViewsRest"
}
},
"/faxes": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the FAX_MANAGE_FAX_SERVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"faxes"
],
"summary": "Add fax services.",
"consumes": [
"application/json"
],
"operationId": "addFaxServicesRest"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the FAX_MANAGE_FAX_SERVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"faxes"
],
"summary": "Update fax services.",
"consumes": [
"application/json"
],
"operationId": "updateFaxServicesRest"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the FAX_MANAGE_FAX_SERVICES feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"faxes"
],
"summary": "Delete fax services.",
"consumes": [
"application/json"
],
"operationId": "deleteFaxServicesRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines a print or fax device."
},
"type": "array"
}
}
},
"description": "Requires the FAX_MANAGE_FAX_SERVICES feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"faxes"
],
"summary": "Get all fax services.",
"operationId": "getAllFaxServicesRest"
}
},
"/email": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the MANAGE_SERVER_SETTINGS feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The email configuration settings for the system."
},
"required": false,
"name": "The updated email settings.",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"email"
],
"summary": "Update the specified email settings.",
"consumes": [
"application/json"
],
"operationId": "setEmailSettings"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The email configuration settings for the system."
},
"type": "array"
}
}
},
"description": "Requires the MANAGE_SERVER_SETTINGS feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"email"
],
"summary": "Get the configured email settings.",
"operationId": "getEmailSettings"
}
},
"/documentType/metadata": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a piece of metadata that is assigned to a specific document type."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The document type ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The boolean indicator to include any indexing configuration for the document type metadata in the response.",
"required": true,
"type": "boolean",
"name": "includeIndexing",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Get the configured metadata for the specified document type.",
"consumes": [
"application/json"
],
"operationId": "getDocumentTypeMetadata"
}
},
"/search": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of the following feature rights: SEARCHES_DELETE, HSM_DELETE.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a search."
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"search"
],
"summary": "Delete the search specified.",
"consumes": [
"application/json"
],
"operationId": "deleteSearchRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A pageable object representing the results of a search."
}
}
},
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, SEARCHES_ASSIGN, SEARCHES_CREATE, SEARCHES_DELETE, SEARCHES_EDIT, HSM_DELETE, HSM_EDIT.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Get all searches (excluding HSM searches) matching the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getSearchesByCriteria"
}
},
"/scansetting/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Representation of scan settings."
},
"type": "array"
}
}
},
"description": "Requires the SCAN_SETTING_MANAGE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Representation of scan settings."
},
"type": "array"
},
"description": "The scanSettingDTOs to add.",
"required": false,
"name": "scanSettings",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Add scan settings.",
"consumes": [
"application/json"
],
"operationId": "addScanSettingsRest"
}
},
"/dashboarddesigner/render/chart": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object defining the information needed to render a chart on a dashboard."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that contains the data necessary to preview a chart."
},
"description": "The arguments needed to render a chart preview.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Render a preview of a chart while in chart configuration.",
"consumes": [
"application/json"
],
"operationId": "renderChart"
}
},
"/category/seek/name": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "",
"parameters": [
{
"description": "The category name to use to seek through the pages of categories.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Find the page location (page number) of the specified category across all pages of categories. ",
"operationId": "getPageIndexForCategoryByName"
}
},
"/validator/unique": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The validator name to check for availability.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Checks if the provided validator name is available for use. ",
"operationId": "isValidatorNameAvailable"
}
},
"/docsecurity/doctype/metadata/canDelete": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "Document type ID in question.",
"required": false,
"type": "string",
"name": "documentTypeId",
"in": "query"
},
{
"description": "Metadata ID to check for unassociation possibilities.",
"required": false,
"type": "string",
"name": "metadataId",
"in": "query"
}
],
"produces": [
"text/plain"
],
"tags": [
"docsecurity"
],
"summary": "Check if it is possible to unassociate the specified metadata with the specified document type or if there are security filters still referencing the metadata.",
"operationId": "canMetadataBeDeletedFromDocumentType"
}
},
"/form/delete": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the FORM_INSTANCE_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Dto object for the summary of a FormInstance."
},
"type": "array"
},
"description": "FormInstanceSummaryDTOs - ID must not be null.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"form"
],
"summary": "Delete the specified form instances from the system.",
"consumes": [
"application/json"
],
"operationId": "deleteFormInstancesREST"
}
},
"/license": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicenseDTO"
}
}
},
"description": "Requires the MANAGE_LICENSES feature right",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Returns the values in the current, active license.",
"operationId": "getLicenseProperties"
}
},
"/document": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following filters: indexed, filterBatchMembers, filterEditLocks, filterPackageItems, displayName, category, documentType, deletedBy, createdBy, dateDeleted, createdDate, includeDeletedDocuments.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Get documents using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDocumentsByCriteriaRest"
}
},
"/importer/narrative/validate": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"type": "string"
},
"description": "The cold narrative to validate.",
"required": false,
"name": "narrative",
"in": "body"
}
],
"tags": [
"importer"
],
"summary": "Validate the cold narrative being sent in.",
"consumes": [
"text/plain"
],
"operationId": "validateColdNarrative"
}
},
"/dbconn": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DATABASECONNECTION_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
},
"description": "The Database Connections to delete.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"dbconn"
],
"summary": "Deletes the database connections.",
"consumes": [
"application/json"
],
"operationId": "deleteDatabaseConnectionRest"
}
},
"/documentType/metadata/assigned": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
}
}
},
"description": "",
"parameters": [
{
"description": "The id of the metadata object to look up assignment. ",
"required": false,
"type": "string",
"name": "metadataId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Get the document types the metadata object is assigned to.",
"consumes": [
"application/json"
],
"operationId": "getDocumentTypesMetadataIsAssignedTo"
}
},
"/hsm/run/{hsmId}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the HSM_START_STOP permission.",
"parameters": [
{
"description": "The HSM that must be run only once",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
}
],
"tags": [
"hsm"
],
"summary": "Run an existing HSM configuration in the system just once.",
"consumes": [
"application/json"
],
"operationId": "runHsmOnce"
}
},
"/ldap/sync/running": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Check if the sync operation is currently running.",
"operationId": "isSyncRunning"
}
},
"/ldap/test/mapping": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/LdapServerDTO object contains connection and user lookup details for the ldap server."
},
"description": "Configuration settings that will be used to retrieve the mapping.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Verify LDAP property mappings by returning a UserDTO for inspection.",
"consumes": [
"application/json"
],
"operationId": "testMapping"
}
},
"/ldap/test/connection": {
"get": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"description": "The LDAP server name.",
"required": false,
"type": "string",
"name": "host",
"in": "query"
},
{
"description": "The LDAP server port.",
"format": "int32",
"default": "389",
"required": false,
"in": "query",
"type": "integer",
"name": "port"
},
{
"description": "If true, then connections to the ldap server will be done via ssl.",
"default": "false",
"required": false,
"in": "query",
"type": "boolean",
"name": "isSSL"
}
],
"tags": [
"ldap"
],
"summary": "Test if the ldap server host name and port are correct.",
"consumes": [
"application/json"
],
"operationId": "testLdapServerConnection"
}
},
"/category/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Representation of a DocFinity category."
}
}
},
"description": "Requires the one of the following feature rights: DOC_CATEGORY_CREATE, DOC_CATEGORY_EDIT.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Representation of a DocFinity category."
},
"description": "The category to update.",
"required": false,
"name": "category",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Update the category.",
"consumes": [
"application/json"
],
"operationId": "updateCategory"
}
},
"/license/pool/group/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicensePoolDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/LicensePoolDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Updates group license pools.",
"consumes": [
"application/json"
],
"operationId": "updateGroupLicensePools"
}
},
"/dashboarddesigner/charts": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
},
"description": "The chart to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Add a new chart.",
"consumes": [
"application/json"
],
"operationId": "addChartable"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
},
"description": "The chart to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Update the specified chart.",
"consumes": [
"application/json"
],
"operationId": "updateChartable"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
},
"description": "The chart to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Delete the specified chart.",
"consumes": [
"application/json"
],
"operationId": "deleteChart"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for charts"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The optional sort options.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "The optional filter options.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "Whether to load child fields. Setting this to true can increase the size of the response.",
"required": false,
"type": "boolean",
"name": "loadChildren",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get a listing of charts using the provided sort, filter and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getCharts"
}
},
"/hsm/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
}
}
},
"description": "Requires the HSM_EDIT feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
},
"description": "The HSM to be added.",
"required": false,
"name": "hsmDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Add a HSM configuration to the system.",
"consumes": [
"application/json"
],
"operationId": "addHsm"
}
},
"/validator/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a validator."
},
"type": "array"
}
}
},
"description": "Requires the VALIDATOR_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a validator."
},
"type": "array"
},
"description": "The Validator DTOs to update.",
"required": false,
"name": "validators",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Update the validators.",
"consumes": [
"application/json"
],
"operationId": "updateValidatorsRest"
}
},
"/dbconn/all": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: DATABASECONNECTION_MANAGE, DATA_STORE_MANAGE, DATASOURCE_MANAGE, VALIDATOR_MANAGE, BPM_DESIGNER.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Gets the database connection configuration represented by the specified id. ",
"operationId": "getDatabaseConnections"
}
},
"/bpm/management/business/holidays/delete": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the BPM_HOLIDAYS_CONFIGURE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
},
"description": "Unneeded holidays",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Delete business holidays.",
"consumes": [
"application/json"
],
"operationId": "deleteHolidaysRest"
}
},
"/wsdlurl/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the wsdl.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"wsdlurl"
],
"summary": "Find all places in the system that use the specified WSDL.",
"consumes": [
"application/json"
],
"operationId": "getWsdlUrlReferences"
}
},
"/validator/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a validator."
},
"type": "array"
}
}
},
"description": "Requires the VALIDATOR_MANAGE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a validator."
},
"type": "array"
},
"description": "The validator DTOs to add.",
"required": false,
"name": "validators",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Add validators.",
"consumes": [
"application/json"
],
"operationId": "addValidatorsRest"
}
},
"/importer/schedule/start": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
}
}
},
"description": "Requires IMPORTER_START_STOP feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
},
"description": "The importer dto to schedule",
"required": false,
"name": "importerDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Schedule an Importer configuration.",
"consumes": [
"application/json"
],
"operationId": "scheduleStartRest"
}
},
"/ldap/sync/system": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Synchronize based on persisted system settings. This may function as synchronizeGroups() or synchronizeUsers().",
"operationId": "synchronizeBySystemSettings"
}
},
"/bpm/management/views/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "Requires BPM_QUEUE_VIEWS_CONFIGURE feature right. ",
"parameters": [
{
"description": "The view id to use to seek through the pages of views.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use. Support name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports id(multiple), name(multiple), excludeNames(multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Find the page location (page number) of the specified view across all pages of views.",
"consumes": [
"application/json"
],
"operationId": "getPageIndexForView"
}
},
"/metadata/check/name": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The metadata name to check",
"required": true,
"type": "string",
"name": "metadataName",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Check whether the specified metadata name is available.",
"consumes": [
"text/plain"
],
"operationId": "isMetadataNameAvailable"
}
},
"/auditing": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for the system."
},
"type": "array"
}
}
},
"description": "Requires the AUDITING_MANAGE feature right.",
"parameters": [
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "maxResults"
}
],
"produces": [
"application/json"
],
"tags": [
"auditing"
],
"summary": "Get a listing of all auditing types and configuration settings.",
"consumes": [
"application/json"
],
"operationId": "getAuditingConfiguration"
}
},
"/dbconn/drivers": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DatabaseDriverDTO"
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Get all the available database drivers. ",
"operationId": "getAllDatabaseDrivers"
}
},
"/documentType/{id}": {
"get": {
"operationId": "getDocumentType",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"tags": [
"documentType"
]
}
},
"/user/suggestions": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "The keyword to use for retrieving suggestions of users.",
"required": true,
"type": "string",
"name": "keyword",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Checks if the provided username is available for use. ",
"operationId": "getSuggestions"
}
},
"/importer/plugins": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get the names of configured importer plugins.",
"operationId": "getImporterPluginNames"
}
},
"/datasources/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The datasource id to use to seek through the pages of datasource.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: datasourceType/type (allows multiple), name, intentType(allows multiple), excludeNames (allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"datasources"
],
"description": "Requires DATASOURCE_MANAGE feature rights.",
"summary": "Find the page location (page number) of the specified datasource across all pages of datasource. ",
"operationId": "getPageIndexForDatasource"
}
},
"/user/password/rules": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Wrapper DTO for working with strong password rules for the system."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Wrapper DTO for working with strong password rules for the system."
},
"description": "The password rules to update, specified in the wrapper object.",
"required": false,
"name": "passwordRulesWrapper",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Password rules to update",
"consumes": [
"application/json"
],
"operationId": "updatePasswordRulesRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Wrapper DTO for working with strong password rules for the system."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get all the password rules defined for the system. ",
"operationId": "getPasswordRulesRest"
}
},
"/hotkeys/reset/all": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A representation of the HotKey entity for use by the web service layer."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"hotkeys"
],
"summary": "Revert all the HotKeys to the default value.",
"operationId": "resetAll"
}
},
"/macros/vars": {
"post": {
"operationId": "getVariableReferences",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"parameters": [
{
"required": false,
"type": "string",
"name": "macro",
"in": "formData"
}
],
"tags": [
"macros"
]
}
},
"/license/pool/group/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicensePoolDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/LicensePoolDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Adds groups to a license pool.",
"consumes": [
"application/json"
],
"operationId": "addGroupLicensePools"
}
},
"/system/transfer/import": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/MultipartBody"
},
"description": "Multipart form body containing the uplaoded file.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"text/plain"
],
"tags": [
"systemtransfer"
],
"summary": "Upload a file, determine its type, and perform the correct import operation on it. Supports system transfer, forms, importer definitions, process models, and dashboards.",
"consumes": [
"multipart/form-data"
],
"operationId": "upload"
}
},
"/importer/schedule/{importerId}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
}
}
},
"description": "",
"parameters": [
{
"description": "The importer ID.",
"required": true,
"type": "string",
"name": "importerId",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get a Importer schedule.",
"operationId": "getScheduledStartTimesRest"
}
},
"/bpm/client/complete/task": {
"post": {
"operationId": "completeTask",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/TaskCompletionDTO"
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/CompleteTaskWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"bpmclient"
]
}
},
"/datastore/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires the DATA_STORE_MANAGE feature right.",
"parameters": [
{
"description": "The datastore id of the datastore.",
"required": true,
"type": "string",
"name": "dataStoreId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"datastore"
],
"summary": "Find all places in the system that use the specified data store.",
"consumes": [
"application/json"
],
"operationId": "getDataStoreReferences"
}
},
"/dashboards/render/dashboard/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object used to render a dashboard."
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The ID of the dashboard to render.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Return the information needed to begin rendering a dashboard.",
"operationId": "renderDashboard"
}
},
"/dashboards/dash/name/{categoryName}/{dashboardName}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
}
}
},
"description": "THIS METHOD IS DEPRECATED. Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard category name.",
"required": true,
"type": "string",
"name": "categoryName",
"in": "path"
},
{
"description": "The dashboard name.",
"required": true,
"type": "string",
"name": "dashboardName",
"in": "path"
}
],
"produces": [
"application/json"
],
"deprecated": true,
"tags": [
"dashboards"
],
"summary": "Get a dashboard by providing its category name and dashboard name. This method is currently only used by the Dojo Mobile application.",
"operationId": "getDashboardByName"
}
},
"/metadata/check/shortName": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The metadata short name to check",
"required": true,
"type": "string",
"name": "metadataShortName",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Check whether the specified metadata short name is available.",
"consumes": [
"text/plain"
],
"operationId": "isMetadataShortNameAvailable"
}
},
"/bpm/client/uncomplete/task/{taskId}": {
"post": {
"operationId": "uncompleteTask",
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "taskId",
"in": "path"
}
],
"tags": [
"bpmclient"
]
}
},
"/documentType/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The document type id to use to seek through the pages of document type.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"documentType"
],
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, SEARCHES_CREATE, SEARCHES_DELETE, SEARCHES_EDIT, DOC_TYPE_EDIT, DOC_TYPE_CREATE.",
"summary": "Find the page location (page number) of the specified document type across all pages of document type.",
"operationId": "getPageIndexForDocumentType"
}
},
"/document/restore": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentErrorResultDTO"
},
"type": "array"
}
}
},
"description": "Requires the DOCUMENT_RESTORE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The IDs of the documents to restore.",
"required": false,
"name": "ids",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Restore the documents specified specified.",
"consumes": [
"application/json"
],
"operationId": "restoreDocuments"
}
},
"/macros": {
"get": {
"operationId": "getMacroList",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/MacroFunctionDTO"
},
"type": "array"
}
}
},
"parameters": [],
"tags": [
"macros"
]
}
},
"/documentType/scansettings": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the scan setting.",
"required": false,
"type": "string",
"name": "scanSettingId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Get the document types to which a given scan setting is assigned.",
"consumes": [
"application/json"
],
"operationId": "getDocumentTypesForScanSetting"
}
},
"/editing": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields: editStartDate, username, category, documentType, documentDisplayValue",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports: documentDisplayName, username, category, documentType, editStartDate, ignoreCanceledEditLocks, ignoreNullDocumentIds",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"editing"
],
"summary": "Get edited documents using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getEditLocksRest"
}
},
"/ldap/sync/user/all": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Synchronize all the users under the system base search DN.",
"operationId": "synchronizeUsers"
}
},
"/documentType/user": {
"get": {
"operationId": "getUserDocumentTypes",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"parameters": [],
"tags": [
"documentType"
]
}
},
"/groups": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the GROUPS_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array"
},
"description": "One or more groups to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"groups"
],
"summary": "Delete one or more groups",
"consumes": [
"application/json"
],
"operationId": "deleteGroupsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for groups."
}
}
},
"description": "Requires one of the following feature rights: GROUPS_CREATE, GROUPS_EDIT, GROUPS_VIEW, SCAN, IMPORTER_CREATE, IMPORTER_EDIT, FORM_DESIGN_ASSIGN, EXPORTER_PROFILE_MANAGE, MANAGE_LICENSES, BPM_JOB_MOVE, BPM_DESIGNER, SCAN_SETTING_MANAGE, SYSTEM_TRANSFER_EXPORT, DASHBOARDS_MANAGE",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: groupStatus/status (allows multiple), groupType/type (allows multiple), name, excludeNames (allows multiple), currentUserMustBeGroupMember (boolean).",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Get groups using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getByCriteria"
}
},
"/ldap/groups/pull": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Retrieve a list of LDAP groups and store it in the database as PulledLdapGroup entities.",
"operationId": "pullLdapGroups"
}
},
"/faxes/plugins": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A plugin DTO that defines the configuration options for a type of Fax service."
},
"type": "array"
}
}
},
"description": "Requires the FAX_MANAGE_FAX_SERVICES feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"faxes"
],
"summary": "Get all configured fax plugins.",
"operationId": "getFaxIntegrationPlugins"
}
},
"/importer/narrative/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Cold importer narrative test data results"
}
}
},
"description": "Requires at least one of the following permissions: IMPORTER_START_STOP, IMPORTER_CREATE, IMPORTER_EDIT, IMPORTER_DELETE.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The cold narrative configuration"
},
"description": "The cold narrative dto to test.Narrative script and raw file must be set.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Test the cold narrative script for the raw file.",
"consumes": [
"application/json"
],
"operationId": "testExecuteColdNarrativeRest"
}
},
"/documentType/copy": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
}
}
},
"description": "Requires the DOC_TYPE_CREATE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DocumentType data used to create a new document type based off an existing document type."
},
"description": "The document type to add.",
"required": false,
"name": "documentType",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Create a new document type based on an existing document type.",
"consumes": [
"application/json"
],
"operationId": "copyDocumentTypeRest"
}
},
"/document/archival/pdf": {
"get": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DIARY_ENTRY feature right.",
"parameters": [
{
"description": "Document Pdf dto",
"required": false,
"type": "string",
"name": "documentPdfDto",
"in": "query"
}
],
"produces": [
"application/octet-stream"
],
"tags": [
"document"
],
"summary": "Data to outline what must be added to the pdf for document archival.",
"consumes": [
"application/json"
],
"operationId": "getDocumentPdfForArchival"
}
},
"/user/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The user id to use to seek through the pages of users.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"user"
],
"description": "",
"summary": "Find the page location (page number) of the specified user across all pages of users. ",
"operationId": "getPageIndexForUser"
}
},
"/license/non/dedicated/groups": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for group totals."
}
}
},
"description": "Requires the MANAGE_LICENSES feature right",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Get groups not assigned to pools using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getNonDedicatedGroups"
}
},
"/groups/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: GROUPS_CREATE, GROUPS_EDIT, GROUPS_DELETE, GROUPS_VIEW",
"parameters": [
{
"description": "The group id to locate references in the system.",
"required": false,
"type": "string",
"name": "groupId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Find all places in the system that reference the provided group.",
"operationId": "getGroupReferences"
}
},
"/form/designer": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: FORM_DESIGNER, FORM_DESIGN_IMPORT, BPM_DESIGNER, SEARCHES_CREATE, SEARCHES_EDIT, FORMS, SYSTEM_TRANSFER_EXPORT",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use. Valid value is name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Valid values are id, name, version, and status.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"formdesigner"
],
"summary": "Get form designs using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDesignsByCriteriaRest"
}
},
"/clipboard/email": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature rights: Email as Outlook Attachment",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that represents an email item that contains one or more clipboard documents."
},
"description": "Object containing email details and document IDs",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"clipboard"
],
"summary": "Audit that some documents were attached to an Outlook email and sent.",
"consumes": [
"application/json"
],
"operationId": "handleItemsSent"
}
},
"/datasources": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the MANAGE_DATASOURCE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The definition of a data source."
},
"type": "array"
},
"description": "The dto of the datasource to delete.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"datasources"
],
"summary": "The datasource to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteDatasourceRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the SYSTEM_TRANSFER_EXPORT or DATASOURCE_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: id (allows multiple), type (allows multiple), name, excludeNames (allows multiple), datasourceType/displayName (allows multiple) , intentType (allows multiple).",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get datasources using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDatasourcesRest"
}
},
"/systemproperties": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A DocFinity system property used to control a setting for the system."
}
}
},
"description": "Requires the MANAGE_SYSTEM_PROPERTIES feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A DocFinity system property used to control a setting for the system."
},
"description": "The system property to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"systemproperties"
],
"summary": "Update the specified system property.",
"consumes": [
"application/json"
],
"operationId": "updateSysProperty"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DocFinity system property used to control a setting for the system."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object holding the sorts to apply. Supports the following: name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object holding the filters to apply. Supports the following : id(multiple), category(multiple),subcategory(multiple. Support eq and contains operator.),name(multiple. Support eq and contains operator.),generic(boolean)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"systemproperties"
],
"summary": "Gets system properties using given sorts and filters.",
"consumes": [
"application/json"
],
"operationId": "getSystemProperties"
}
},
"/importer/narrative/test/result": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "Requires at least one of the following permissions: IMPORTER_START_STOP, IMPORTER_CREATE, IMPORTER_EDIT, IMPORTER_DELETE.",
"parameters": [
{
"description": "The cold narrative test result ID.",
"required": false,
"type": "string",
"name": "narrativeTestId",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "200",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get the tests results of cold narrative execution.",
"consumes": [
"application/json"
],
"operationId": "retrieveColdNarrativeTestResultRest"
}
},
"/ldap/groups": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Information about groups pulled from an LDAP server."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Current supported filters are groupName, objectGuid, lastPulled, and synchronize.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Returns a page collection of groups pulled from LDAP.",
"consumes": [
"application/json"
],
"operationId": "getPulledLdapGroups"
}
},
"/form/designer/activate/{id}": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A data transfer object representing a form design."
}
}
},
"description": "Requires the FORM_DESIGN_ACTIVATE feature right.",
"parameters": [
{
"description": "Form id to activate.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"formdesigner"
],
"summary": "Activates the working copy of the specified form design, making it available for users.",
"consumes": [
"application/json"
],
"operationId": "activateDesign"
}
},
"/license/pool/group": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicensePoolDTO"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Returns the group license pools.",
"operationId": "getGroupLicensePools"
}
},
"/dashboarddesigner/dashboards/ci": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Check in the specified dashboard, indicating you are finished editing it.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "checkInDashboardDesign"
}
},
"/hsm/stop/{hsmId}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the HSM_START_STOP permission.",
"parameters": [
{
"description": "The HSM that must be stopped",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
}
],
"tags": [
"hsm"
],
"summary": "Stop an existing HSM configuration in the system.",
"consumes": [
"application/json"
],
"operationId": "stopHsm"
}
},
"/dashboarddesigner/dashboards/co": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Check out the specified dashboard for editing.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "checkOutDashboardDesign"
}
},
"/dashboards/render/drillDownDashboard": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object containing the information needed to render a drill down to a dashboard."
}
}
},
"description": "Requires the DASHBOARDS_VIEW feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that provides the arguments needed to render a chart on a dashboard."
},
"description": "The arguments needed to render the dashboard drill down.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Render a drill down from a chart to a dashboard.",
"consumes": [
"application/json"
],
"operationId": "renderDrillDownDashboard"
}
},
"/docsecurity/groups/unassigned": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged result for document type group assignments."
}
}
},
"description": "Requires the following feature right: DOC_TYPE_SECURITY",
"parameters": [
{
"description": "Document type ID to filter out groups.",
"required": false,
"type": "string",
"name": "documentTypeId",
"in": "query"
},
{
"description": "Group name (optional) to filter out groups that start with this string.",
"required": false,
"type": "string",
"name": "groupName",
"in": "query"
},
{
"description": "Sorts to apply",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Get a page of groups that are not associated to the specified document type. Document type id is required. The group name parameter is optional, but can be used as a filter, matching against a startsWith operator.",
"consumes": [
"application/json"
],
"operationId": "getUnassociatedGroupsByDocumentType"
}
},
"/repository": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/RepositoryDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Add a new repository.",
"consumes": [
"application/json"
],
"operationId": "addRepositoriesRest"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires either the REPOSITORY_CREATE or REPOSITORY_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/RepositoryDTO"
},
"type": "array"
},
"description": "The repositories to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Update the specified repositories.",
"consumes": [
"application/json"
],
"operationId": "updateRepositoriesRest"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the REPOSITORY_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/RepositoryDTO"
},
"type": "array"
},
"description": "The repository to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"repository"
],
"summary": "Delete the specified repository.",
"consumes": [
"application/json"
],
"operationId": "deleteRepositoriesRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/RepositoryDTO"
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get all repositories, sorted by retrieval priority.",
"operationId": "getRepositories"
}
},
"/dashboarddesigner/categories/filtered": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A category used to group together related dashboards."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "A Filters object containing optional filters.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get all dashboard categories, sorted by category name, while filtering on any specified criteria.",
"consumes": [
"application/json"
],
"operationId": "getDashboardCategoriesFiltered"
}
},
"/document/search/category/execute": {
"post": {
"operationId": "searchDocumentsByCategory",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/SearchExecutionWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"document"
]
}
},
"/dbconn/id": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DatabaseConnectionDTO"
}
}
},
"description": "",
"parameters": [
{
"description": "The id of the database connection webservice.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Gets the database connection configuration represented by the specified id. ",
"operationId": "getDatabaseConnection"
}
},
"/groups/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array"
}
}
},
"description": "Require the GROUPS_CREATE feature right. The group field is required, others are optional.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A DTO for adding a group and all of its associations on one operation."
},
"type": "array"
},
"description": "One or more groups to add. Allows you to set feature rights and security for each group.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Add a group. Allows you to set members, feature rights, and security as well.",
"consumes": [
"application/json"
],
"operationId": "addGroupsRest"
}
},
"/user/unique": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The username to check for availability.",
"required": true,
"type": "string",
"name": "username",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Checks if the provided username is available for use. ",
"operationId": "isUsernameAvailable"
}
},
"/dbconn/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
}
}
},
"description": "Requires the DATABASECONNECTION_MANAGE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
},
"description": "The Database Connection DTOs to update.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Update the database connections.",
"consumes": [
"application/json"
],
"operationId": "updateDatabaseConnections"
}
},
"/dashboarddesigner/dashboards/ul/many": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The dashboard IDs to unlock.",
"required": true,
"name": "ids",
"in": "body"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Unlock the specified dashboards that is currently locked by someone else, potentially causing them to lose work..",
"consumes": [
"application/json"
],
"operationId": "unlockDashboardDesigns"
}
},
"/license/message": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/LicenseEmailDTO"
},
"description": "The messaging information to use.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Sets the information about messaging for license related things.",
"consumes": [
"application/json"
],
"operationId": "setEmailContact"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicenseEmailDTO"
}
}
},
"description": "Requires the MANAGE_LICENSES feature right",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Gets the information about messaging for license related things.",
"operationId": "getEmailContact"
}
},
"/exporter/admin": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
}
}
},
"description": "Requires EXPORTER_PROFILE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
},
"description": "The exporter profile dto to be updated.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Update an existing exporter profile in the system.",
"consumes": [
"application/json"
],
"operationId": "updateExporterProfileRest"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the EXPORTER_PROFILE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
},
"description": "The exporter profile dto to be delete.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"exporteradmin"
],
"summary": "The exporter profile to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteExporterProfile"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the SYSTEM_TRANSFER_EXPORT or EXPORTER_PROFILE_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: name (allows multiple), id(allows multiple), excludeNames (allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Get exporter profiles using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getExporterProfilesByCriteriaRest"
}
},
"/dashboards/categories/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_VIEW feature right.",
"parameters": [
{
"description": "The ID of the dashboard category.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get a listing of all dashboards in the specified dashboard category to which the current user has group access. Items are returned in ascending order by name.",
"operationId": "listDashboards"
}
},
"/ldap/sync/groups": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Synchronize all the groups, and users in the aforementioned groups, under the system base search DN.",
"operationId": "synchronizeGroups"
}
},
"/validator/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ValidateStatus"
}
}
},
"description": "Requires the following feature rights: VALIDATOR_MANAGE.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object representing a validator and data to test."
},
"description": "The Validator to test.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Test the Validator.",
"consumes": [
"application/json"
],
"operationId": "testValidator"
}
},
"/bpm/client/get/tasks/{jobId}": {
"get": {
"operationId": "getTasksForJob",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocfinityTaskDTO"
},
"type": "array"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "jobId",
"in": "path"
}
],
"tags": [
"bpmclient"
]
}
},
"/document/datasource/{datasourceId}/execute": {
"post": {
"operationId": "executeDatasource",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "datasourceId",
"in": "path"
},
{
"schema": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"document"
]
}
},
"/groups/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array"
}
}
},
"description": "Require the GROUPS_CREATE or GROUPS_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array"
},
"description": "One or more groups to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Update one or more groups.",
"consumes": [
"application/json"
],
"operationId": "updateGroupsRest"
}
},
"/auditing/processmodels/configure": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for individual process models."
},
"type": "array"
}
}
},
"description": "Requires the AUDITING_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for individual process models."
},
"type": "array"
},
"description": "The process models and their auditing configuration settings to turn auditing for models ON or OFF.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"auditing"
],
"summary": "Configure the auditing settings to turn ON/OFF specific audit messages.",
"consumes": [
"application/json"
],
"operationId": "configureAuditingPerProcessModels"
}
},
"/bpm/management/views/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/View data used to configure job views for the system."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: BPM_QUEUE_VIEWS_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/View data used to configure job views for the system."
},
"type": "array"
},
"description": "viewDtos",
"required": false,
"name": "The job views to be added to the system",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Add one or more views to the system.",
"consumes": [
"application/json"
],
"operationId": "addViewsRest"
}
},
"/license/pool/user/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicensePoolDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/LicensePoolDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Adds users to a license pool.",
"consumes": [
"application/json"
],
"operationId": "addUserLicensePools"
}
},
"/user/login-props": {
"get": {
"operationId": "getLoginProperties",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LoginPropertiesDTO"
}
}
},
"parameters": [],
"tags": [
"user"
]
}
},
"/datasources/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A generic result object that can be used to return instances of List and Map."
},
"type": "array"
}
}
},
"description": "Requires DATASOURCE_MANAGE feature rights. ",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object representing a datasource and data to test."
},
"description": "The datasource and arguments to test the datasource.",
"required": false,
"name": "datasourceTestingDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Test the datasource in the supplied dto.",
"consumes": [
"application/json"
],
"operationId": "testDatasource"
}
},
"/bpm/management/views/{viewId}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/View data used to configure job views for the system."
}
}
},
"description": "",
"parameters": [
{
"description": "viewId",
"required": true,
"type": "string",
"name": "The view id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Get a a job view associated with the view id.",
"consumes": [
"application/json"
],
"operationId": "getViewById"
}
},
"/license/non/dedicated/users": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: USERS_CREATE",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Gets active users that are not in a dedicated license pool.",
"consumes": [
"application/json"
],
"operationId": "getNonDedicatedUsers"
}
},
"/metadata/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires one of the following METADATA_CREATE, METADATA_EDIT or METADATA_DELETE feature rights.",
"parameters": [
{
"description": "The metadata id to locate references in the system.",
"required": true,
"type": "string",
"name": "metadataId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Find all places in the system that reference the provided metadata.",
"operationId": "getMetadataReferences"
}
},
"/hsm/{hsmId}/preview": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the DOCUMENT_SEARCH feature right.",
"parameters": [
{
"description": "HSM policy ID",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
},
{
"description": "Start index",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "Page size",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Search for documents in the system based on an HSM policy.",
"consumes": [
"application/json"
],
"operationId": "previewSearchResults"
}
},
"/printfax": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
}
}
},
"description": "Requires one of PRINTFAX_MANAGE_SERVERS, FAX_MANAGE_SERVERS feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"printfax"
],
"summary": "Add print/fax servers.",
"consumes": [
"application/json"
],
"operationId": "addServersRest"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
}
}
},
"description": "Requires one of PRINTFAX_MANAGE_SERVERS, FAX_MANAGE_SERVERS feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"printfax"
],
"summary": "Update print/fax servers.",
"consumes": [
"application/json"
],
"operationId": "updateServersRest"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of PRINTFAX_MANAGE_SERVERS, FAX_MANAGE_SERVERS feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"printfax"
],
"summary": "Delete print/fax servers.",
"consumes": [
"application/json"
],
"operationId": "deleteServersRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"type": "array"
}
}
},
"description": "Requires one of PRINTFAX_MANAGE_SERVERS, FAX_MANAGE_SERVERS feature rights.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"printfax"
],
"summary": "Get the current print/fax servers.",
"consumes": [
"application/json"
],
"operationId": "getServersRest"
}
},
"/permissions/group": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A single feature right assigned to a group."
},
"type": "array"
}
}
},
"description": "Requires the GROUPS_CREATE or GROUPS_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A single feature right assigned to a group."
},
"type": "array"
},
"description": "The group feature rights to add or delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Add or delete group feature rights.",
"consumes": [
"application/json"
],
"operationId": "saveGroupFeatureRights"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A single feature right assigned to a group."
},
"type": "array"
}
}
},
"description": "If showAll is false, this method returns only the feature rights that are assigned to this group. Is showAll is true, this method returns every feature right, and indicates which ones are assigned by setting the 'assigned' flag of the GroupFeatureRightDTO. If groupId is not provided, the method will return all rights in the system if showAll is true, and nothing is showAll is false.",
"parameters": [
{
"description": "The ID of the group. If not provided, returns all feature rights in the system when showAll is true, and nothing when showAll is false.",
"required": false,
"type": "string",
"name": "groupId",
"in": "query"
},
{
"description": "If true, show all rights, even those not assigned to the group.",
"default": "false",
"required": false,
"in": "query",
"type": "boolean",
"name": "showAll"
}
],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Gets the feature rights currently assigned to the specified group.",
"consumes": [
"text/plain"
],
"operationId": "getGroupFeatureRightsRest"
}
},
"/macros/validate": {
"post": {
"operationId": "validateMacro",
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"required": false,
"type": "string",
"name": "macro",
"in": "formData"
}
],
"tags": [
"macros"
]
}
},
"/servers/this/codebase": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "",
"parameters": [],
"produces": [
"text/plain"
],
"tags": [
"servers"
],
"summary": "Returns the code base name (codeName) of the software running on this node.",
"operationId": "getThisServerCodeBase"
}
},
"/repository/purgeRenderings": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires one of the REPOSITORY_CREATE, REPOSITORY_EDIT, or REPOSITORY_DELETE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/RepositoryDTO"
},
"type": "array"
},
"description": "The path to check.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"repository"
],
"summary": "Purge all renderings located in the specified repositories.",
"consumes": [
"application/json"
],
"operationId": "purgeRenderingsRest"
}
},
"/hsm/start/{hsmId}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the HSM_START_STOP permission.",
"parameters": [
{
"description": "The HSM that must be started",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
}
],
"tags": [
"hsm"
],
"summary": "Start an existing HSM configuration in the system.",
"consumes": [
"application/json"
],
"operationId": "startHsm"
}
},
"/overlays": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Object that represents a document overlay."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields: name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports: name.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"overlays"
],
"summary": "Get overlays using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getOverlaysRest"
}
},
"/bpm/management/shifts/members": {
"put": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: BPM_SHIFTS_CONFIGURE",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DTO representing shift membership changes."
},
"description": "DTO containing update details.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Updates the specified shift memberships.",
"consumes": [
"application/json"
],
"operationId": "addShiftMembersToShift"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: BPM_SHIFTS_CONFIGURE",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DTO representing shift membership changes."
},
"description": "DTO containing update details.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Updates the specified shift memberships.",
"consumes": [
"application/json"
],
"operationId": "removeMembersFromShift"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the following feature right: BPM_SHIFTS_CONFIGURE",
"parameters": [
{
"description": "ID of shift to check.",
"required": false,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. A filter of (assigned=true) will return ONLY those users already assigned to the specified shift.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Gets a paged collection of users assigned to a shift.",
"consumes": [
"application/json"
],
"operationId": "getShiftAssignmentDetails"
}
},
"/dbconn/test": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of the following feature rights: DATABASECONNECTION_MANAGE, DATA_STORE_MANAGE, DATASOURCE_MANAGE, VALIDATOR_MANAGE, BPM_DESIGNER.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"description": "The Database Connection DTO to test.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"dbconn"
],
"summary": "Test the Database Connection is valid.",
"consumes": [
"application/json"
],
"operationId": "testDatabaseConnection"
}
},
"/servers/this/version": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "",
"parameters": [],
"produces": [
"text/plain"
],
"tags": [
"servers"
],
"summary": "Returns the four digit version ID of this server node. If version ID cannot be found, return 0.0.0.0.",
"operationId": "getThisServerVersion"
}
},
"/bpm/management/business/holidays/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
}
}
},
"description": "Requires the BPM_HOLIDAYS_CONFIGURE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
},
"description": "New holidays.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Add business holidays.",
"consumes": [
"application/json"
],
"operationId": "addHolidays"
}
},
"/dashboarddesigner/inputs/new": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An input to a dashboard."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"description": "The dashboard input type.",
"required": true,
"in": "query",
"type": "string",
"name": "type"
},
{
"enum": [
"BOOLEAN",
"DATE",
"DECIMAL",
"INTEGER",
"STRING"
],
"description": "The static input type, only applicable if type is STATIC.",
"required": false,
"in": "query",
"type": "string",
"name": "staticType"
},
{
"enum": [
"SWITCH",
"DATE",
"DROP_DOWN_LIST",
"TEXT"
],
"description": "The prompt type, only applicable if the type is PROMPT.",
"required": false,
"in": "query",
"type": "string",
"name": "promptType"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get an empty DashboardInputDTO object of the specified type.",
"consumes": [
"application/json"
],
"operationId": "getNewInput"
}
},
"/scansetting/port": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"description": "Requires the SCAN_SETTING_MANAGE feature right.",
"parameters": [
{
"description": "The port number to be used for all scanning clients.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "portNumber"
}
],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Set the port number to be used for all scanning clients. Modifying this value also requires that all scan client programs be updated to use the new port number.",
"consumes": [
"application/json"
],
"operationId": "setScanningPortNumber"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Get the scanning port number.",
"operationId": "getScanningPortNumber"
}
},
"/login/change": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"required": false,
"type": "string",
"name": "username",
"in": "formData"
},
{
"required": false,
"type": "string",
"name": "oldPassword",
"in": "formData"
},
{
"required": false,
"type": "string",
"name": "newPassword",
"in": "formData"
}
],
"produces": [
"application/json"
],
"tags": [
"login"
],
"summary": "Change the password of an internal user.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "changePasswordWithInternalValidation"
}
},
"/dbconn/schemas": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The definition of the database schema."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The id of the database connection webservice.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Find all schema names in the database referenced by the database connection id",
"operationId": "getSchemaNamesRest"
}
},
"/repository/getDiskInfo/{name}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "",
"parameters": [
{
"description": "The name of the repository.",
"required": true,
"type": "string",
"name": "name",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get the disk information for the given repository name.",
"consumes": [
"application/json"
],
"operationId": "getRepositoryDiskInformationRest"
}
},
"/datastore/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DataStore data used to configure datastores for the system."
}
}
},
"description": "Requires the DATA_STORE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DataStore data used to configure datastores for the system."
},
"description": "The datastore to be updated.",
"required": false,
"name": "dataStore",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datastore"
],
"summary": "Update a datastore in the system.",
"consumes": [
"application/json"
],
"operationId": "updateDataStoreRest"
}
},
"/log/clear": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"log"
],
"summary": "Clear the log file.",
"consumes": [
"application/json"
],
"operationId": "clearLogFile"
}
},
"/overlays/upload": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/TempOverlayDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/MultipartBody"
},
"description": "Multipart form body containing the uplaoded file.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"text/plain"
],
"tags": [
"overlays"
],
"summary": "Upload an overlay file and store it in a temporary directory. Returns a UID representing the overlay, which can then be provided to an add/update call.",
"consumes": [
"multipart/form-data"
],
"operationId": "upload"
}
},
"/overlays/upload/preview": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/TempOverlayDTO"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/MultipartBody"
},
"description": "Multipart form body containing the uploaded file for preview.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"text/plain"
],
"tags": [
"overlays"
],
"summary": "Upload a file to use when previewing an overlay. The file will be stored in a temporary file and cleaned up automatically at a later time.",
"consumes": [
"multipart/form-data"
],
"operationId": "uploadPreview"
}
},
"/dashboarddesigner/charts/new": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"description": "The chart type.",
"required": true,
"in": "query",
"type": "string",
"name": "type"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get an empty chart DTO object for the specified chart type.",
"consumes": [
"application/json"
],
"operationId": "getNewChart"
}
},
"/repository/plugins": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get the names of all repository plugins.",
"operationId": "getRepositoryPluginNames"
}
},
"/repository/purgeAllRenderings": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires one of the REPOSITORY_CREATE, REPOSITORY_EDIT, or REPOSITORY_DELETE feature rights.",
"parameters": [],
"tags": [
"repository"
],
"summary": "Purge all renderings located in all accessible repositories.",
"consumes": [
"application/json"
],
"operationId": "purgeAllRenderings"
}
},
"/form/unlock": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "If the instance is not checked out this method does nothing. Requires the FORM_INSTANCE_UNLOCK feature right.",
"parameters": [
{
"description": "The form instance id.",
"required": false,
"type": "string",
"name": "id",
"in": "query"
}
],
"tags": [
"form"
],
"summary": "Checks in the form instance with specified id.",
"consumes": [
"application/json"
],
"operationId": "unlockFormInstance"
}
},
"/overlays/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Object that represents a document overlay."
}
}
},
"description": "Requires the following feature right: OVERLAY_MANAGE",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Object that represents a document overlay."
},
"description": "The overlay to update",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"overlays"
],
"summary": "Delete an overlay.",
"consumes": [
"application/json"
],
"operationId": "updateOverlay"
}
},
"/dashboarddesigner/charts/validate": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A validation result containing warnings and errors."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
},
"description": "The chart to validate.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Validate the specified chart.",
"consumes": [
"application/json"
],
"operationId": "validateChartable"
}
},
"/license/pool/group/delete": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/LicensePoolDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"license"
],
"summary": "Deletes the specified license pool groups.",
"consumes": [
"application/json"
],
"operationId": "deleteLicensePoolGroups"
}
},
"/hsm/validate": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
}
}
},
"description": "Requires the HSM_EDIT feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The Hsm validation dto."
},
"description": "The hsm validation dto to validate.",
"required": false,
"name": "hsmValidationDto",
"in": "body"
}
],
"tags": [
"hsm"
],
"summary": "Validate a HSM configuration, its associated schedule and search.",
"consumes": [
"application/json"
],
"operationId": "validateHsmRest"
}
},
"/dashboarddesigner/dashboards/ul": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Unlock a dashboard that is currently locked by someone else, potentially causing them to lose work.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "unlockDashboardDesign"
}
},
"/category/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Representation of a DocFinity category."
}
}
},
"description": "Requires the DOC_CATEGORY_CREATE feature rights.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Representation of a DocFinity category."
},
"description": "The category to add.",
"required": false,
"name": "category",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Add a category.",
"consumes": [
"application/json"
],
"operationId": "addCategory"
}
},
"/hsm/unique": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The hsm name to check for availability.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Check whether the specified hsm name is available.",
"operationId": "isHsmNameAvailable"
}
},
"/bpm/management/roles/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires BPM_ROLE_PROXY_CONFIGURE feature right. ",
"parameters": [
{
"description": "The role id to locate references in the system.",
"required": false,
"type": "string",
"name": "roleId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Find all places in the system that reference the provided role.",
"operationId": "getRoleReferences"
}
},
"/search/enterprise/test/search": {
"get": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"required": false,
"type": "string",
"name": "uri",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Test enterprise search server URI.",
"consumes": [
"application/json"
],
"operationId": "testSearchServer"
}
},
"/overlays/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires the following feature right: OVERLAY_MANAGE",
"parameters": [
{
"description": "The overlay ID to search for.",
"required": false,
"type": "string",
"name": "overlayId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"overlays"
],
"summary": "Find all places in the system that reference the provided overlay.",
"operationId": "getOverlayReferences"
}
},
"/permissions/user": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A feature right for the system."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the user to use to retrieve associated feature rights.",
"required": true,
"type": "string",
"name": "userId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Get the feature rights associated to this user.",
"operationId": "getFeatureRightsByUser"
}
},
"/ldap/test/authentication": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"description": "The LDAP server name.",
"required": false,
"type": "string",
"name": "host",
"in": "formData"
},
{
"description": "The LDAP server port.",
"format": "int32",
"required": false,
"in": "formData",
"type": "integer",
"name": "port"
},
{
"description": "If true, then connections to the ldap server will be done via ssl.",
"default": "false",
"required": false,
"in": "formData",
"type": "boolean",
"name": "isSSL"
},
{
"description": "The userDn. This should be the entire distinguished name of the user.",
"required": false,
"type": "string",
"name": "userDn",
"in": "formData"
},
{
"description": "The base domain to use.",
"required": false,
"type": "string",
"name": "baseDn",
"in": "formData"
},
{
"description": "The password.",
"required": false,
"type": "string",
"name": "password",
"in": "formData"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Test if the host name, port number, username and password supplied in the LdapServerDTO connect to the correct ldap server.",
"operationId": "testLdapServerAuthentication"
}
},
"/category/space/{categoryId}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires the DOCUMENT_HIERARCHY feature right.",
"parameters": [
{
"description": "The ID of the category to check for available space to add a document type.",
"required": true,
"type": "string",
"name": "categoryId",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Check the specified category to verify that there is available space to add a document type to the category.",
"operationId": "verifyDocumentTypeSpace"
}
},
"/hsm/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The hsm id to use to seek through the pages of hsm.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: id (allows multiple), name (allows multiple), excludeNames (allows multiple), server(allows multiple), runningStatus",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"hsm"
],
"description": "",
"summary": "Find the page location (page number) of the specified hsm across all pages of hsm. ",
"operationId": "getPageIndexForHsm"
}
},
"/documentType/find": {
"post": {
"operationId": "getDocumentTypesByCriteria",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/DocumentTypeCriteria"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"documentType"
]
}
},
"/bpm/client/processModels/packageItems": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following rights BPM_DESIGNER, IMPORTER_CREATE, IMPORTER_EDIT, SYSTEM_TRANSFER_EXPORT",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "The required size of package items, Valid values are -1, 0 or 1.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "requiredItems"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Gets the ProcessModelNameDescription of all process models based on a specified level of required package items.",
"operationId": "getQuantifiedPackageItemProcessModelsRest"
}
},
"/license/snapshot": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GlobalSessionDTO"
}
}
},
"description": "Requires the MANAGE_LICENSES feature right",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Current supported filters are username, firstName, and lastName.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Returns a snapshot of the current licenses in use.",
"consumes": [
"application/json"
],
"operationId": "getGlobalSessionsSnapshot"
}
},
"/datasources/plugin/ui": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": "array"
}
}
},
"description": "Requires MANAGE_DATASOURCE feature right.",
"parameters": [
{
"description": "A datasource type to load the appropriate user interface",
"required": false,
"type": "string",
"name": "type",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get the UI of the datasource type.",
"operationId": "getDatasourceUserInterface"
}
},
"/dashboarddesigner/dashboards/validate": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A validation result containing warnings and errors."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"description": "The dashboard to validate.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Validate the specified dashboard.",
"consumes": [
"application/json"
],
"operationId": "validateDashboard"
}
},
"/repository/checkWritable": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The path to check.",
"required": false,
"type": "string",
"name": "path",
"in": "query"
}
],
"tags": [
"repository"
],
"summary": "Checks if the repository path is writable.",
"consumes": [
"application/json"
],
"operationId": "checkRepositoryWritable"
}
},
"/dashboarddesigner/dashboards/saveas": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object containing the data needed to invoke a save as operation for a dashboard."
},
"description": "Object containing instructions for how to save the dashboard.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Make a copy of a dashboard, or overwrite another dashboard.",
"consumes": [
"application/json"
],
"operationId": "saveDashboardAs"
}
},
"/documentType/inclusive/{id}": {
"get": {
"operationId": "getDocumentTypeInclusive",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"tags": [
"documentType"
]
}
},
"/dbconn/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: DATABASECONNECTION_MANAGE, DATA_STORE_MANAGE, DATASOURCE_MANAGE, VALIDATOR_MANAGE, BPM_DESIGNER.",
"parameters": [
{
"description": "The database connection ID to search for.",
"required": true,
"type": "string",
"name": "databaseConnectionId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Find all places in the system that reference the specified database connection.",
"consumes": [
"application/json"
],
"operationId": "getDatabaseConnectionReferences"
}
},
"/dashboarddesigner/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID to locate references in the system.",
"required": true,
"type": "string",
"name": "dashboardId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Find all places in the system that reference the provided dashboard.",
"operationId": "getDashboardReferences"
}
},
"/bpm/management/views/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires BPM_QUEUE_VIEWS_CONFIGURE feature right. ",
"parameters": [
{
"description": "The view name to check",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Check whether the specified view name is available.",
"consumes": [
"text/plain"
],
"operationId": "isViewNameAvailable"
}
},
"/metadata/category": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the category to retrieve associated metadata.",
"required": false,
"type": "string",
"name": "categoryId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Get the metadata associated with active document types contained in the specified category.",
"consumes": [
"application/json"
],
"operationId": "getByCategory"
}
},
"/dbconn/tables": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The definition of the database schema and tables within that schema."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The id of the database connection webservice.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The optional database schema name.",
"required": false,
"type": "string",
"name": "schema",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Find all table names in the database pointed to by the database connection, optionally supplying a schema name ",
"operationId": "getTableNamesRest"
}
},
"/importer/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The representation of an Importer object."
},
"type": "array"
}
}
},
"description": "Requires the IMPORTER_EDIT permission to edit the importer. If there is a schedule associated with the importer and the importer is schedule to start IMPORTER_START_STOPis also needed.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The representation of an Importer object."
},
"type": "array"
},
"description": "The importers to add.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Update importers in the system.",
"consumes": [
"application/json"
],
"operationId": "updateImportersRest"
}
},
"/bpm/management/shifts": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The DTO object for a Shift's intrinsic properties and shift parts."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The DTO object for a Shift's intrinsic properties and shift parts."
},
"description": "Representation of entity to create.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Adds the specified shift.",
"consumes": [
"application/json"
],
"operationId": "addShift"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The DTO object for a Shift's intrinsic properties and shift parts."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The DTO object for a Shift's intrinsic properties and shift parts."
},
"description": "Representation of entity for update.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Updates the specified shifts.",
"consumes": [
"application/json"
],
"operationId": "updateShift"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The Ids of the Shifts to delete.",
"required": false,
"name": "shiftIds",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Deletes the specified shifts.",
"consumes": [
"application/json"
],
"operationId": "deleteShiftsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The DTO object for a Shift's intrinsic properties and shift parts."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Returns all the currently saved shifts as an array of root shift dtos. These DTOs do not contain assignments.",
"operationId": "getShiftRoots"
}
},
"/overlays/docType": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Represents the relationship between an Overlay and a Document Type."
},
"type": "array"
}
}
},
"description": "Requires the OVERLAY_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Represents the relationship between an Overlay and a Document Type."
},
"type": "array"
},
"description": "Document type overlay dto which requires the documentTypeId and overlayId to be specified.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"overlays"
],
"summary": "Update or remove the overlay to document type association.",
"consumes": [
"application/json"
],
"operationId": "saveDocumentTypeOverlays"
}
},
"/documentType/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"description": "Requires the DOC_TYPE_CREATE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
},
"description": "The document type DTOs to add.",
"required": false,
"name": "documentTypes",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Add document types.",
"consumes": [
"application/json"
],
"operationId": "addDocumentTypes"
}
},
"/bpm/client/docType": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentTypeProcessModelDTO"
}
}
},
"description": "Requires the BPM_MODEL_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DocumentTypeProcessModelDTO"
},
"description": "Document type process model dto which requires the documentTypeId and processModelId to be specified.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Update or remove the process model to document type association.",
"consumes": [
"application/json"
],
"operationId": "modifyDocumentTypeProcessModel"
}
},
"/form/library/{name}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Wrapper class used to hold both standard form version details as well as separate properties that provide details for the Form's working copy."
}
}
},
"description": "Requires the FORM_MANAGE feature right.",
"parameters": [
{
"description": "Form versions for this form will be returned.",
"required": true,
"type": "string",
"name": "name",
"in": "path"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"form"
],
"summary": "Get form version details using the provided sort and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getPagedFormMonitoringDtos"
}
},
"/metadata": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the METADATA_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
},
"type": "array"
},
"description": "The dtos of the metadata to delete.",
"required": false,
"name": "metadata",
"in": "body"
}
],
"tags": [
"metadata"
],
"summary": "The metadata objects to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteMetadataRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: METADATA_CREATE, METADATA_EDIT, METADATA_DELETE, DATASOURCE_MANAGE, DOC_TYPE_METADATA, SEARCHES_CREATE, SEARCHES_DELETE, SEARCHES_EDIT.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following filters name , metadataType",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: metadataType/type (allows multiple), name (allows multiple), shortName, isCollection(Boolean), maxLength(Integer), minLength(Integer), length(Integer) , description , ids (multiple), documentTypeId (String), categoryId (String).NOTE: The categoryId filter cannot be used in conjunction with any other filter at this time.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Get metadatas using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getMetadatasByCriteriaRest"
}
},
"/indexingconfig/batchnaming": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Represents the configuration for a single part of batch names."
},
"type": "array"
}
}
},
"description": "Requires the BATCH_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Represents the configuration for a single part of batch names."
},
"type": "array"
},
"description": "The updated batch name configuration.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"indexingconfig"
],
"summary": "Update the current batch naming configuration.",
"consumes": [
"application/json"
],
"operationId": "updateBatchNameConfigurations"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Represents the configuration for a single part of batch names."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"indexingconfig"
],
"summary": "Get the current batch naming configuration.",
"operationId": "getAllBatchNameConfigurations"
}
},
"/hsm/disable/{hsmId}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the HSM_START_STOP permission.",
"parameters": [
{
"description": "The HSM policy whose schedule must be disabled.",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
}
],
"tags": [
"hsm"
],
"summary": "Delete all existing schedules for a HSM policy.",
"consumes": [
"application/json"
],
"operationId": "disableHsm"
}
},
"/metadata/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The metadata id to use to seek through the pages of metadata.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name , metadataType",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: metadataType/type (allows multiple), name (allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"metadata"
],
"description": "",
"summary": "Find the page location (page number) of the specified metadata across all pages of metadata. ",
"operationId": "getPageIndexForMetadata"
}
},
"/hsm/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
}
}
},
"description": "Requires the HSM_EDIT feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
},
"description": "The HSM to be added.",
"required": false,
"name": "hsmDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Update an existing HSM configuration in the system.",
"consumes": [
"application/json"
],
"operationId": "updateHsm"
}
},
"/search/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The search id to use to seek through the pages of searches.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"search"
],
"description": "",
"summary": "Find the page location (page number) of the specified search across all pages of searches. ",
"operationId": "getPageIndexForSearch"
}
},
"/exporter/admin/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
}
}
},
"description": "",
"parameters": [
{
"description": "The exporter profile ID.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Get a export profile.",
"operationId": "getExporterProfile"
}
},
"/dashboarddesigner/user/assigned": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "dashboardId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Determine whether the current user is assigned to a dashboard via group access.",
"consumes": [
"application/json"
],
"operationId": "isUserAssignedToDashboard"
}
},
"/search/getSearches": {
"get": {
"operationId": "getMySearchesList",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The representation of a search."
},
"type": "array"
}
}
},
"parameters": [],
"tags": [
"search"
]
}
},
"/servers/this/timezone": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "",
"parameters": [],
"produces": [
"text/plain"
],
"tags": [
"servers"
],
"summary": "Returns the timezone of the system running this node.",
"operationId": "getThisServerTimeZone"
}
},
"/paperclip/getDocuments/forClip/{paperClipId}": {
"get": {
"operationId": "getDocumentsByPaperClip",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "paperClipId",
"in": "path"
},
{
"default": "false",
"required": false,
"type": "boolean",
"name": "showDeleted",
"in": "query"
}
],
"tags": [
"paperclip"
]
}
},
"/permissions": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A feature right for the system."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Gets all feature rights.",
"operationId": "getFeatureRights"
}
},
"/metadata/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
}
}
},
"description": "Requires one of the following METADATA_CREATE or METADATA_EDIT feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
},
"type": "array"
},
"description": "The metadatas to be added.",
"required": false,
"name": "metadata",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Add metadata objects to the system.",
"consumes": [
"application/json"
],
"operationId": "addMetadataRest"
}
},
"/indexing/batches/checkIn": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the BATCH_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "One or more batch IDs to check in.",
"required": false,
"name": "batchIds",
"in": "body"
}
],
"tags": [
"indexing"
],
"summary": "Check in the specified batches.",
"consumes": [
"application/json"
],
"operationId": "checkInBatches"
}
},
"/overlays/delete": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: OVERLAY_MANAGE",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Object that represents a document overlay."
},
"description": "The overlay to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"overlays"
],
"summary": "Delete an overlay.",
"consumes": [
"application/json"
],
"operationId": "deleteOverlayRest"
}
},
"/document/getSearch/{searchId}": {
"get": {
"operationId": "getSearch",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a search."
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "searchId",
"in": "path"
}
],
"tags": [
"document"
]
}
},
"/importer/validate": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"importer"
],
"summary": "Validate an Importer configuration.",
"consumes": [
"application/json"
],
"operationId": "validateImporterConfiguration"
}
},
"/dashboards/macro": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object containing the information needed in order to execute a macro."
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Execute a macro used in a user prompt.",
"consumes": [
"application/json"
],
"operationId": "executeMacro"
}
},
"/exporter/admin/fileSizeUnit": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"enum": [
"KB",
"MB",
"GB"
],
"type": "string"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Get the file size units that we support.",
"operationId": "getFileSizeUnit"
}
},
"/hsm": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the HSM_DELETE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
},
"description": "The HSM dto to delete",
"required": false,
"name": "hsmDto",
"in": "body"
}
],
"tags": [
"hsm"
],
"summary": "The hsm to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteHsmRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the following feature right: SYSTEM_TRANSFER_EXPORT",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Get HSM policies using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "get"
}
},
"/dashboarddesigner/parameters": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An input to a dashboard."
},
"type": "array"
},
"description": "The current dashboard inputs.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Build an array of generic prompt objects that can be fed into our generic prompt list.",
"consumes": [
"application/json"
],
"operationId": "buildParameterPrompts"
}
},
"/log": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Entry for a logging module."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"log"
],
"summary": "Get the log level for all loggers.",
"consumes": [
"application/json"
],
"operationId": "getLoggers"
}
},
"/dashboarddesigner/charts/ul/many": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The chart IDs to unlock.",
"required": true,
"name": "ids",
"in": "body"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Unlock the specified chart that is currently locked by someone else, potentially causing them to lose work..",
"consumes": [
"application/json"
],
"operationId": "unlockChartDesigns"
}
},
"/exporter/admin/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The exporter profile id to use to seek through the pages of exporter profile.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: name (allows multiple), id(allows multiple), excludeNames (allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"exporteradmin"
],
"description": "Requires EXPORTER_PROFILE_MANAGE feature rights.",
"summary": "Find the page location (page number) of the specified exporter profile across all pages of exporter profile. ",
"operationId": "getPageIndexForExporterProfile"
}
},
"/dashboarddesigner/charts/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The chart ID to locate references in the system.",
"required": true,
"type": "string",
"name": "chartId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Find all places in the system that reference the provided chart.",
"operationId": "getChartReferences"
}
},
"/dashboarddesigner/categories/{id}": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"description": "The ID of the dashboard category to delete.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"tags": [
"dashboarddesigner"
],
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"summary": "Delete the specified dashboard category.",
"operationId": "deleteDashboardCategory"
}
},
"/usersettings/save": {
"post": {
"operationId": "saveUserSettings",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserSettingDTO"
},
"type": "array"
}
}
},
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/UserSettingDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"usersettings"
]
}
},
"/repository/updateStorageOption": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the REPOSITORY_EDIT feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/RepositoryStorageOptionDTO"
},
"description": "The storage option for the system.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Update the specified document storage option for the system.",
"consumes": [
"application/json"
],
"operationId": "updateStorageOptionRest"
}
},
"/clipboard": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Object representing an item on the clipboard for a user."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: Email as Outlook Attachment",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Document Ids",
"required": true,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"clipboard"
],
"summary": "Add documents to the clipboard for the current user.",
"operationId": "addItems"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: Email as Outlook Attachment",
"parameters": [],
"tags": [
"clipboard"
],
"summary": "Delete all clipboard items for the current user.",
"consumes": [
"application/json"
],
"operationId": "deleteAllItemsForUser"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Object representing an item on the clipboard for a user."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: Email as Outlook Attachment",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"clipboard"
],
"summary": "Get the current clipboard items for the current user.",
"operationId": "getItemsForUser"
}
},
"/groups/members/get": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: GROUPS_CREATE, GROUPS_EDIT, GROUPS_DELETE, GROUPS_VIEW, MANAGE_LICENSES, BPM_DESIGNER.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object representing a query for group members."
},
"description": "Object that holds group IDs, paging settings, sorts and filters. Supports sorting on username, firstName, and lastName. Supports filtering on id (allows multiple), userId (allows multiple), groupId (allows multiple), groupAdministrator (boolean), status/userStatus (allows multiple), username, firstName, lastName, user (combined), level/associationLevel.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Get the users who are members of a given group.",
"consumes": [
"application/json"
],
"operationId": "getGroupMembersRest"
}
},
"/datastore/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DataStore data used to configure datastores for the system."
}
}
},
"description": "Requires the DATA_STORE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DataStore data used to configure datastores for the system."
},
"description": "The datastore to be added.",
"required": false,
"name": "dataStore",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datastore"
],
"summary": "Add a datastore to the system.",
"consumes": [
"application/json"
],
"operationId": "addDataStoreRest"
}
},
"/bpm/client/complete/job": {
"post": {
"operationId": "completeJob",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/JobCompletionDTO"
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/CompleteJobWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"bpmclient"
]
}
},
"/form/designer/unlock/{id}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the FORM_DESIGN_UNLOCK feature right.",
"parameters": [
{
"description": "Form id to unlock.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"tags": [
"formdesigner"
],
"summary": "Unlocks a form design, unlocking it from the current user so that it may be edited by someone else. If the form design is not currently locked, this method does nothing.",
"consumes": [
"application/json"
],
"operationId": "unlockDesign"
}
},
"/log/{name}/{level}": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Entry for a logging module."
}
}
},
"description": "",
"parameters": [
{
"description": "Logger name.",
"required": true,
"type": "string",
"name": "name",
"in": "path"
},
{
"enum": [
"OFF",
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
"TRACE",
"ALL"
],
"description": "Logger level.",
"required": true,
"in": "path",
"type": "string",
"name": "level"
}
],
"produces": [
"application/json"
],
"tags": [
"log"
],
"summary": "Set the log level for a logger.",
"consumes": [
"application/json"
],
"operationId": "setLogLevel"
}
},
"/category/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "",
"parameters": [
{
"description": "The category id to use to seek through the pages of categories.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Find the page location (page number) of the specified category across all pages of categories. ",
"operationId": "getPageIndexForCategory"
}
},
"/importer/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
}
}
},
"description": "",
"parameters": [
{
"description": "The importer ID.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get the full configuration for an importer.",
"operationId": "getImporterConfiguration"
}
},
"/auditing/configure": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for the system."
},
"type": "array"
}
}
},
"description": "Requires the AUDITING_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for the system."
},
"type": "array"
},
"description": "Auditing types to enable or disable.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"auditing"
],
"summary": "Configure the auditing settings to turn ON/OFF specific audit messages.",
"consumes": [
"application/json"
],
"operationId": "configureAuditing"
}
},
"/bpm/management/roles/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "Requires BPM_ROLE_PROXY_CONFIGURE feature right. ",
"parameters": [
{
"description": "The group name to check",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Check whether the specified role name is available.",
"consumes": [
"text/plain"
],
"operationId": "isRoleNameAvailable"
}
},
"/datasources/types": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A plugin DTO for Datasources."
},
"type": "array"
}
}
},
"description": "Requires the DATASOURCE_MANAGE feature right.",
"parameters": [
{
"enum": [
"COMPLEX_TABLE",
"SIMPLE"
],
"description": "The datasource intent type.",
"required": false,
"in": "query",
"type": "string",
"name": "intentType"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get all datasource types that support the provided datasource intent type. If you do not provide an intent type, all datasource types are returned.",
"operationId": "getSupportedDatasourceTypes"
}
},
"/user/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
}
}
},
"description": "Requires the USERS_CREATE or USERS_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
},
"description": "The User DTOs to update.",
"required": false,
"name": "users",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Update the users.",
"consumes": [
"application/json"
],
"operationId": "updateUsersRest"
}
},
"/dashboarddesigner/categories": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A category used to group together related dashboards."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A category used to group together related dashboards."
},
"description": "The dashboard category to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Add a new dashboard category.",
"consumes": [
"application/json"
],
"operationId": "addDashboardCategory"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A category used to group together related dashboards."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A category used to group together related dashboards."
},
"description": "The dashboard category to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Update the specified dashboard category.",
"consumes": [
"application/json"
],
"operationId": "updateDashboardCategory"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A category used to group together related dashboards."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "Flag indicating whether results should exclude categories that already contain the maximum of 250 dashboards.",
"default": "false",
"required": false,
"in": "query",
"type": "boolean",
"name": "filterMaxDashboards"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get all dashboard categories, sorted by name.",
"operationId": "getDashboardCategories"
}
},
"/search/save": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a search."
}
}
},
"description": "Requires one of the following feature rights, based on the intended action: SEARCHES_ASSIGN, SEARCHES_CREATE, SEARCHES_EDIT, HSM_EDIT, SEARCHES_DELETE, HSM_DELETE.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of a search."
},
"description": "The Search DTO to add, update or delete.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Add, update or delete the specified search.",
"consumes": [
"application/json"
],
"operationId": "saveSearchesRest"
}
},
"/metadataValue/count": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"description": "",
"parameters": [
{
"description": "The metadata shortname to locate references in the system.",
"required": true,
"type": "string",
"name": "metadataShortname",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"metadataValue"
],
"summary": "Get the number of documents associated with specified metadata object.",
"consumes": [
"text/plain"
],
"operationId": "getDocumentCountByMetadata"
}
},
"/document/search/prompts/{searchId}/{intent}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The representation of the search parameter prompt."
},
"type": "array"
}
}
},
"description": "The default values of prompts will be determined by the intent",
"parameters": [
{
"description": "The id of the search",
"required": true,
"type": "string",
"name": "searchId",
"in": "path"
},
{
"enum": [
"ADMIN",
"EXECUTION",
"RESET_TO_DEFAULTS"
],
"description": "The intent of the listing. Valid values are EXECUTION and ADMIN",
"required": true,
"in": "path",
"type": "string",
"name": "intent"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Get all of the prompts for a given search",
"operationId": "getGenericPromptsForSearch"
}
},
"/importer": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the IMPORTER_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The representation of an Importer object."
},
"type": "array"
},
"description": "The importers to delete.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"importer"
],
"summary": "The datasource to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteImportersRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the SYSTEM_TRANSFER_EXPORT feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use. + The fields that can be used are : name, processType(INDEX/OBJECT/EMAIL/COLD/REPORT), running(true/false), pending(true/false)",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. The fields that can be used are : ids (allows multiple) , name, status(ACTIVE/INACTIVE), processType(INDEX/OBJECT/EMAIL/COLD/REPORT), running(true/false), pending(true/false), excludeNames(allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get importers using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getImportersByCriteriaRest"
}
},
"/user/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
}
}
},
"description": "Requires the USERS_CREATE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
},
"description": "The user DTOs to add.",
"required": false,
"name": "users",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Add users.",
"consumes": [
"application/json"
],
"operationId": "addUsersRest"
}
},
"/email/validate": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the MANAGE_SERVER_SETTINGS feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The email configuration settings for the system."
},
"description": "The email settings to validate.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"email"
],
"summary": "Validate the configured email settings and generate a test message.",
"consumes": [
"application/json"
],
"operationId": "validateEmailSettings"
}
},
"/records/retention/policy": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"records"
],
"summary": "Get retention policies using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getRetentionPoliciesByCriteriaRest"
}
},
"/importer/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The importer name to check",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Check whether the specified importer name is available.",
"consumes": [
"text/plain"
],
"operationId": "isImporterNameAvailable"
}
},
"/exporter/admin/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The exporter profile name to check",
"required": true,
"type": "string",
"name": "exporterProfileName",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Check whether the specified exporterProfile name is available.",
"consumes": [
"text/plain"
],
"operationId": "isExporterProfileNameAvailable"
}
},
"/scansetting/docType": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of the relationship between a document type and a set of scan settings."
}
}
},
"description": "Requires the SCAN_SETTING_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of the relationship between a document type and a set of scan settings."
},
"description": "Document type scan setting dto which requires the documentTypeId and scanSettingId to be specified.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Update or remove the scan setting to document type association.",
"consumes": [
"application/json"
],
"operationId": "modifyDocumentTypeScanSettings"
}
},
"/category/user": {
"get": {
"operationId": "getUserCategories",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Representation of a DocFinity category."
},
"type": "array"
}
}
},
"parameters": [],
"tags": [
"category"
]
}
},
"/hsm/{hsmId}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of HSM configuration."
}
}
},
"description": "Requires the following feature right: HSM_DELETE, HSM_EDIT, HSM_START_STOP }",
"parameters": [
{
"description": "The id to use to load the hsm.",
"required": true,
"type": "string",
"name": "hsmId",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Get HSM policy using the provided HSM id.",
"operationId": "getHsmById"
}
},
"/search/unique": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The search name to check for availability.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Checks if the provided search name is available for use. ",
"operationId": "isSearchNameAvailable"
}
},
"/log/{level}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"enum": [
"OFF",
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
"TRACE",
"ALL"
],
"description": "Logger level.",
"required": true,
"in": "path",
"type": "string",
"name": "level"
}
],
"produces": [
"application/json"
],
"tags": [
"log"
],
"summary": "Set the log level for all loggers.",
"consumes": [
"application/json"
],
"operationId": "setLogLevelForAll"
}
},
"/ldap/sync/user/{id}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "This method synchronizes the supplied external user DTO object.",
"operationId": "synchronizeUser"
}
},
"/search/{searchId}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a search."
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the search to retrieve.",
"required": true,
"type": "string",
"name": "searchId",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Get the search identified by the specified ID.",
"operationId": "getSearchWithAdminIntent"
}
},
"/user": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the USERS_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
},
"description": "The users to delete.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"user"
],
"summary": "Delete the users specified.",
"consumes": [
"application/json"
],
"operationId": "deleteUsersRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: USERS_CREATE, USERS_EDIT, USERS_VIEW, IMPORTER_START_STOP, BPM_JOB_MOVE, BPM_DESIGNER, BPM_ROLE_PROXY_CONFIGURE, MANAGE_LICENSES",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get users using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getUsers"
}
},
"/dashboarddesigner/charts/co": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The chart ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Check out the specified chart for editing.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "checkOutChartDesign"
}
},
"/dashboarddesigner/charts/ci": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The chart ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Check in the specified chart design, indicating you are finished editing it.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "checkInChartDesign"
}
},
"/exporter/admin/structure": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"DISPLAY_NAME",
"USERNAME",
"DATE_TIME",
"DATE_CREATED"
],
"type": "string"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Properties which could be used to name the directory structure , documents of the exported zip and its contents. Or the bookmarks when export type is SINGLE_PDF.",
"operationId": "getExporterDocVariables"
}
},
"/document/search/template/execute": {
"post": {
"operationId": "searchDocumentsByTreeDrivenTemplate",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/SearchExecutionWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"document"
]
}
},
"/search/save/promptValues": {
"post": {
"operationId": "saveSearchPromptValues",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/SearchPromptValueDTO"
},
"type": "array"
}
}
},
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/SearchPromptValueDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"search"
]
}
},
"/ldap/properties": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/LdapServerDTO object contains connection and user lookup details for the ldap server."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/LdapServerDTO object contains connection and user lookup details for the ldap server."
},
"description": "LdapServerDTO",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Set the ldap server properties.",
"operationId": "setLdapServerProperties"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LdapServerDTO object contains connection and user lookup details for the ldap server."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Get the ldap server properties.",
"operationId": "getAllLdapServerProperties"
}
},
"/datasources/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires DATASOURCE_MANAGE feature rights. ",
"parameters": [
{
"description": "The datasource id to locate references in the system.",
"required": false,
"type": "string",
"name": "datasourceId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Find all places in the system that reference the provided datasource.",
"operationId": "getDatasourceReferences"
}
},
"/bpm/client/return/job/{jobId}": {
"get": {
"operationId": "returnJob",
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "jobId",
"in": "path"
}
],
"tags": [
"bpmclient"
]
}
},
"/document/uploaded/byPermissionType": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "permissionTypes",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "maxNum"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Get the documents uploaded by the current logged in user which are not indexed, are not part of a batch, and are not currently flowing in a business process.",
"consumes": [
"application/json"
],
"operationId": "getUploadedDocumentsByPermissionTypeRest"
}
},
"/indexing/index": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the INDEX feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/IndexingValuesDTO"
},
"description": "The object containing all indexing values to save and delete for the specified documents.",
"required": false,
"name": "indexingValuesDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"indexing"
],
"summary": "FOR TESTING ONLY - this service is subject to change so use with caution! The service will index the specified documents.",
"consumes": [
"application/json"
],
"operationId": "indexDocumentsRest"
}
},
"/docsecurity/user": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the user to examine.",
"required": false,
"type": "string",
"name": "userId",
"in": "query"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Get the collection of document types to which the specified user has access.",
"consumes": [
"application/json"
],
"operationId": "getDistinctDocumentTypesForUser"
}
},
"/datasources/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of a data source."
}
}
},
"description": "Requires the DATASOURCE_MANAGE feature right. See <a href='../publicapi/somepage.html'>here</a>",
"parameters": [
{
"description": "The datasource ID.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get a datasource.",
"operationId": "getDatasource"
}
},
"/bpm/client/get/package/{jobId}": {
"get": {
"operationId": "getPackageByJobId",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/PackageItemDTO"
},
"type": "array"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "jobId",
"in": "path"
}
],
"tags": [
"bpmclient"
]
}
},
"/storedprocedure/storedprocedure/search/execute": {
"post": {
"operationId": "performStoredProcedureSearch",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/SearchExecutionWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"storedprocedure"
]
}
},
"/docsecurity/user/details": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"enum": [
"LIST",
"VIEW",
"DELETE",
"UPDATE",
"EDIT",
"OVERRIDE_REDACTIONS",
"VIEW_MARKUP"
],
"type": "string"
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the user to examine.",
"required": false,
"type": "string",
"name": "userId",
"in": "query"
},
{
"description": "The ID of the document type to examine.",
"required": false,
"type": "string",
"name": "documentTypeId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Get the specific security access levels that the user has access to for this document type.",
"consumes": [
"application/json"
],
"operationId": "getSecurityDetails"
}
},
"/systemproperties/reset/all": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DocFinity system property used to control a setting for the system."
},
"type": "array"
}
}
},
"description": "Requires the MANAGE_SYSTEM_PROPERTIES feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"systemproperties"
],
"summary": "Reset all the system properties to their generic default.",
"operationId": "resetAllGeneric"
}
},
"/dashboarddesigner/categories/count": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard category ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"text/plain"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get the number of dashboards contained within the specified dashboard category.",
"operationId": "getCountOfDashboardsInCategory"
}
},
"/document/deleted": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: DOCUMENT_RESTORE, DOCUMENT_PURGE.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following filters: indexed, filterBatchMembers, filterEditLocks, filterPackageItems, displayName, category, documentType, deletedBy, createdBy, dateDeleted, createdDate, includeDeletedDocuments.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Get deleted documents using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDeletedDocumentsByCriteriaRest"
}
},
"/datastore/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The dataStore id to use to seek through the pages of dataStore.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields : name",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: id (allows multiple), name (allows multiple), excludeNames (allows multiple).",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"datastore"
],
"description": "",
"summary": "Find the page location (page number) of the specified metadata across all pages of metadata. ",
"operationId": "getPageIndexForDataStore"
}
},
"/scansetting/storage/types": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The representation of the storage type entity used for scanning configuration."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Get the storage types in the system for scanning.",
"operationId": "getStorageTypes"
}
},
"/document/purge": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentErrorResultDTO"
},
"type": "array"
}
}
},
"description": "Requires the DOCUMENT_PURGE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The IDs of the documents to purge.",
"required": false,
"name": "ids",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Purge the documents specified.",
"consumes": [
"application/json"
],
"operationId": "purgeDocuments"
}
},
"/permissions/classifications": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A grouping category for feature rights."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"enum": [
"FEATURE_RIGHT",
"GROUP_ADMINISTRATION",
"SYSTEM_ACCESS"
],
"name": "type",
"default": "FEATURE_RIGHT",
"required": false,
"in": "query",
"type": "string"
}
],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Gets all permission classifications for the specified type.",
"operationId": "getPermissionClassificationsByType"
}
},
"/dashboards/render/dashboardChartable": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object defining the information needed to render a chart on a dashboard."
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that provides the arguments needed to render a chart on a dashboard."
},
"description": "The arguments needed to render the chart.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Render a single chart on a dashboard. Returns an object that contains, among other things, a JSON object that is given to a Kendo Chart.",
"consumes": [
"application/json"
],
"operationId": "renderDashboardChartable"
}
},
"/form/summary/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the FORM_MANAGE feature right.",
"parameters": [
{
"description": "The ID of the form to examine.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"form"
],
"summary": "Gets a paged collection of form instance summaries for the specified form.",
"consumes": [
"application/json"
],
"operationId": "getFormInstanceSumamries"
}
},
"/form/library": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the FORM_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"form"
],
"summary": "Get form designs using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getFormLibraryDtos"
}
},
"/validator": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the VALIDATOR_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a validator."
},
"type": "array"
},
"description": "The validators to delete.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"validator"
],
"summary": "Delete the validators specified.",
"consumes": [
"application/json"
],
"operationId": "deleteValidatorsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object representing a pageable collection of validators."
}
}
},
"description": "Requires one of the following feature rights: VALIDATOR_MANAGE, FORM_DESIGNER, FORMS, INDEX, INDEXING_CONFIG_MANAGE, SYSTEM_TRANSFER_EXPORT.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "The flag directing the inclusion or exclusion of nested data objects.",
"required": false,
"type": "boolean",
"name": "nestedFlag",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Get validators using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getValidatorsByCriteriaRest"
}
},
"/dashboarddesigner/datasource": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic result object that can be used to return instances of List and Map."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The datasource ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"schema": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array"
},
"description": "The arguments to use as parameters when executing the datasource.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Execute the specified datasource and view its resulting data in raw form.",
"consumes": [
"application/json"
],
"operationId": "previewDatasourceExecution"
}
},
"/dashboarddesigner/groups": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing the assignment of a dashboard to a group."
},
"type": "array"
},
"description": "An array of dashboard to group mappings to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"deprecated": true,
"tags": [
"dashboarddesigner"
],
"summary": "Assign groups to a dashboard.",
"consumes": [
"application/json"
],
"operationId": "assignDashboardGroups"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing the assignment of a dashboard to a group."
},
"type": "array"
},
"description": "The dashboard groups to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"deprecated": true,
"tags": [
"dashboarddesigner"
],
"summary": "Delete one or more dashboard group assignments.",
"consumes": [
"application/json"
],
"operationId": "deleteDashboardGroups"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for dashboard groups."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object containing optional sorting instructions.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object containing optional filters.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "Whether to load child fields.",
"required": false,
"type": "boolean",
"name": "loadChildren",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get a listing of dashboard groups using the specified sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getGroups"
}
},
"/importer/path": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
},
"description": "The importer dto whose monitored path is to be verfied.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Check whether the specified directory path is valid on the server.",
"consumes": [
"application/json"
],
"operationId": "isDirectoryValidRest"
}
},
"/search/enterprise": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Enterprise search configuration."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Enterprise search configuration."
},
"description": "Enterprise search configuration.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Set enterprise search configuration.",
"consumes": [
"application/json"
],
"operationId": "setEnterpriseSearchConfiguration"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Enterprise search configuration."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Get enterprise search configuration.",
"consumes": [
"application/json"
],
"operationId": "getEnterpriseSearchConfiguration"
}
},
"/ldap/groups/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Information about groups pulled from an LDAP server."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Information about groups pulled from an LDAP server."
},
"type": "array"
},
"description": "Groups to synchronize. Only the synchronize property is read.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Set the synchronization value, and only the synchronization value for the Pulled LDAP Group.",
"consumes": [
"application/json"
],
"operationId": "setGroupSynchronizationStatuses"
}
},
"/dashboarddesigner/dashboards": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"description": "The dashboard to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Add a new dashboard.",
"consumes": [
"application/json"
],
"operationId": "addDashboard"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"description": "The dashboard to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Update the specified dashboard.",
"consumes": [
"application/json"
],
"operationId": "updateDashboard"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"description": "The dashboard to delete",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"dashboarddesigner"
],
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"summary": "Delete the specified dashboard.",
"operationId": "deleteDashboardRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for dashboards."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "Whether to load child DTO fields. Can greatly increase the size of the response.",
"default": "false",
"required": false,
"in": "query",
"type": "boolean",
"name": "loadChildren"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get dashboards using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDashboards"
}
},
"/metadata/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
}
}
},
"description": "Requires one of the following METADATA_CREATE or METADATA_EDIT feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
},
"type": "array"
},
"description": "The metadatas to be updated.",
"required": false,
"name": "metadata",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"metadata"
],
"summary": "Update metadata objects in the system.",
"consumes": [
"application/json"
],
"operationId": "updateMetadataRest"
}
},
"/datastore/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The dataStore name to check",
"required": true,
"type": "string",
"name": "dataStoreName",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"datastore"
],
"summary": "Check whether the specified datastore name is available.",
"consumes": [
"text/plain"
],
"operationId": "isDataStoreNameAvailable"
}
},
"/importer/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The representation of an Importer object."
},
"type": "array"
}
}
},
"description": "Requires the IMPORTER_CREATE or IMPORTER_EDIT permission. If there is a schedule associated with the importer and the importer is schedule to start IMPORTER_START_STOPis also needed.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The representation of an Importer object."
},
"type": "array"
},
"description": "The importers to add.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Add importers to the system.",
"consumes": [
"application/json"
],
"operationId": "addImportersRest"
}
},
"/systemproperties/reset/{id}": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DocFinity system property used to control a setting for the system."
},
"type": "array"
}
}
},
"description": "Requires the MANAGE_SYSTEM_PROPERTIES feature right.",
"parameters": [
{
"description": "The system property id to reset.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"systemproperties"
],
"summary": "Reset the system property to its generic default.",
"operationId": "resetSysProperty"
}
},
"/paperclip/getClips/forDocument/{documentId}": {
"get": {
"operationId": "getPaperClipsByDocument",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "documentId",
"in": "path"
}
],
"tags": [
"paperclip"
]
}
},
"/ldap/schedule": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DTO for a GenericSchedule entity."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"description": "Schedule for LDAP synchronization.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Schedule an LDAP synchronization.",
"operationId": "scheduleLdapSync"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DTO for a GenericSchedule entity."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Get the schedules times LDAP will synchronize.",
"operationId": "getLdapSchedule"
}
},
"/dbconn/columns": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DatabaseColumnDTO"
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The id of the database connection webservice.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The optional database schema name.",
"required": false,
"type": "string",
"name": "schema",
"in": "query"
},
{
"description": "The database table name.",
"required": true,
"type": "string",
"name": "table",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Find all column names for a table in the database pointed to by the database connection, optionally supplying a schema name ",
"operationId": "getColumns"
}
},
"/dashboards/categories/bydash": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A category used to group together related dashboards."
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The ID of the dashboard.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get the dashboard category for the specified dashboard.",
"consumes": [
"application/json"
],
"operationId": "getDashboardCategoryForDashboard"
}
},
"/documentType/documentTypeMetadata": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object representing the collection of document type to metadata associations."
}
}
},
"description": "Requires the DOC_TYPE_METADATA feature right. When trying to configure additional indexing configuration data, the INDEXING_CONFIG_MANAGE is required.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object representing the collection of document type to metadata associations."
},
"description": "The document type to metadata associations to save.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Save the document type to metadata associations.",
"consumes": [
"application/json"
],
"operationId": "saveDocumentTypeMetadataRest"
}
},
"/exporter/admin/exportTypes": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The output types supported by the exporting process."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Get the export types that we support.",
"operationId": "getExporterOutputTypes"
}
},
"/license/pool/user/delete": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/LicensePoolDTO"
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"license"
],
"summary": "Deletes the specified license pool users.",
"consumes": [
"application/json"
],
"operationId": "deleteLicensePoolUsers"
}
},
"/document/hsm/preview": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the DOCUMENT_SEARCH feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The representation of the hsm search preview dto object."
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Search for documents in the system based on the hsm configuration policy.",
"consumes": [
"application/json"
],
"operationId": "searchDocumentsByHsmRest"
}
},
"/bpm/client/processModels/variables": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "Process model name.",
"required": false,
"type": "string",
"name": "processModelName",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Gets the names of all process instance variables contained in the active version of this model.",
"consumes": [
"application/json"
],
"operationId": "getProcessInstanceVariableNames"
}
},
"/document/delete": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentErrorResultDTO"
},
"type": "array"
}
}
},
"description": "Requires the DOCUMENT_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The IDs of the documents to delete.",
"required": false,
"name": "ids",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"document"
],
"summary": "Delete the documents specified.",
"consumes": [
"application/json"
],
"operationId": "deleteDocuments"
}
},
"/dashboarddesigner/dependencies": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An input to a dashboard."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An input to a dashboard."
},
"type": "array"
},
"description": "The current dashboard inputs.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Build the dependency mapping for dashboard inputs, and check for circular dependencies.",
"consumes": [
"application/json"
],
"operationId": "buildParameterDependencies"
}
},
"/form/designer/delete": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the FORM_DESIGN_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Form ids to delete.",
"required": false,
"name": "ids",
"in": "body"
}
],
"tags": [
"formdesigner"
],
"summary": "Deletes the specified form design versions from the system. This method is mainly provided as a convenience to clean up very old versions of forms that no longer need to be kept in the system.",
"consumes": [
"application/json"
],
"operationId": "deleteDesign"
}
},
"/auditing/processmodels": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Auditing data used to configure auditing levels for individual process models."
},
"type": "array"
}
}
},
"description": "Requires the AUDITING_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters supported for narrowing down the configuration set. Currently, process model name is supported.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"auditing"
],
"summary": "Get a listing of all auditing configuration settings for all process models.",
"consumes": [
"application/json"
],
"operationId": "getAuditingConfigurationPerProcessModels"
}
},
"/validator/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object representing a validator."
}
}
},
"description": "Requires the VALIDATOR_MANAGE feature right.",
"parameters": [
{
"description": "The datasource ID.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Get a validator.",
"operationId": "getValidator"
}
},
"/login/reset": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"required": false,
"type": "string",
"name": "username",
"in": "formData"
}
],
"produces": [
"application/json"
],
"deprecated": true,
"tags": [
"login"
],
"summary": "Resets the password for the specified user and sends an email to the user.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "resetPassword"
}
},
"/permissions/user/details": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the user to use to retrieve associated feature right details.",
"required": true,
"type": "string",
"name": "userId",
"in": "query"
},
{
"description": "The ID of the feature right to use to retrieve associated feature right details.",
"required": true,
"type": "string",
"name": "featureRightId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"permissions"
],
"summary": "Get the feature right details (assigned groups) associated to this user and feature right.",
"operationId": "getFeatureRightDetailsByUser"
}
},
"/groups/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The group id to use to seek through the pages of groups.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.Supports the following fields: groupStatus/status (allows multiple), groupType/type (allows multiple), name, excludeNames (allows multiple), currentUserMustBeGroupMember (boolean).",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"groups"
],
"description": "",
"summary": "Find the page location (page number) of the specified group across all pages of groups. ",
"operationId": "getPageIndexForGroup"
}
},
"/datasources/parameters": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array"
}
}
},
"description": "Requires DATASOURCE_MANAGE feature rights. ",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of a data source."
},
"description": "The datasource to obtain the parameters for.",
"required": false,
"name": "datasourceDto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get the parameters for the supplied datasource dto.",
"consumes": [
"application/json"
],
"operationId": "getDatasourceParameters"
}
},
"/repository/getStorageOption": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Gets the document storage option for the system.",
"operationId": "getStorageOptionRest"
}
},
"/dashboards/categories/user": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A category used to group together related dashboards."
},
"type": "array"
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANAGE feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get a listing of all dashboard categories to which the current user has group access. Items are returned in ascending order by name.",
"consumes": [
"application/json"
],
"operationId": "getDashboardCategoriesForLoggedInUser"
}
},
"/importer/new": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of an Importer object."
}
}
},
"description": "",
"parameters": [
{
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"description": "The importer type.",
"required": true,
"in": "query",
"type": "string",
"name": "type"
}
],
"produces": [
"application/json"
],
"tags": [
"importer"
],
"summary": "Get an empty importer DTO object for the specified importer type.",
"consumes": [
"application/json"
],
"operationId": "getNewImporter"
}
},
"/wsdlurl/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A representation of the wsdl url object that can be applied to get requests."
},
"description": "The WSDL URL object to test.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"wsdlurl"
],
"summary": "Test the WSDL URL is valid.",
"consumes": [
"application/json"
],
"operationId": "testWsdlRest"
}
},
"/documentType/add/inclusive": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"description": "Requires the DOC_TYPE_CREATE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"description": "The document type to add.",
"required": false,
"name": "documentType",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Add a document types and all its associated entities and configurations.",
"consumes": [
"application/json"
],
"operationId": "addDocumentTypeInclusive"
}
},
"/printers/byserver": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object that defines a print or fax device."
}
}
},
"description": "",
"parameters": [
{
"description": "The ID of the print server",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"printers"
],
"summary": "Get the printers connected to the given print server.",
"operationId": "getPrintersConnectedToServer"
}
},
"/bpm/management/roles/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A role used in business process management."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: BPM_ROLE_PROXY_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A role used in business process management."
},
"type": "array"
},
"description": "One or more roles to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Update one or more roles.",
"consumes": [
"application/json"
],
"operationId": "updateRolesRest"
}
},
"/dashboards/render/drillDownDashboardChartable": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object defining the information needed to render a chart on a dashboard."
}
}
},
"description": "Requires the DASHBOARDS_VIEW feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that provides the arguments needed to render a chart on a dashboard."
},
"description": "The arguments needed to render the chart drill down.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Render a drill down from a chart to another chart.",
"consumes": [
"application/json"
],
"operationId": "renderDashboardChartableDrillDown"
}
},
"/validator/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "",
"parameters": [
{
"description": "The validator id to use to seek through the pages of validators.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Find the page location (page number) of the specified validator across all pages of validators. ",
"operationId": "getPageIndexForValidator"
}
},
"/bpm/management/roles/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A role used in business process management."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: BPM_ROLE_PROXY_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A role used in business process management."
},
"type": "array"
},
"description": "One or more roles to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Add one or more roles to the system.",
"consumes": [
"application/json"
],
"operationId": "addRolesRest"
}
},
"/bpm/client/seek/name": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "",
"parameters": [
{
"description": "The process model name to use to seek through the pages of process models.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The required size of package items, Valid values are -1, 0 or 1.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "requiredItems"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Find the page location (page number) of the specified process model across all pages of process models. ",
"operationId": "getPageIndexForProcessModelByName"
}
},
"/license/revoke/batch": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A username and IP address identifier used to revoke licenses for a specific user on a specific host."
},
"type": "array"
},
"description": "List of user and IP address pairs to revoke.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"license"
],
"description": "",
"summary": "Revokes a list of licenses so another user may use them.",
"operationId": "revokeLicensedUsers"
}
},
"/documentType/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
}
}
},
"description": "Requires one of the following feature rights: DOC_TYPE_EDIT, DOC_TYPE_CREATE.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"description": "The document type to update.",
"required": false,
"name": "documentType",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Update the document type.",
"consumes": [
"application/json"
],
"operationId": "updateDocumentType"
}
},
"/hsm/docVariables": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "Requires one of the following feature rights: HSM_EDIT, SEARCHES_CREATE, SEARCHES_EDIT",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Get the document variables that can be used in the HSM policy configuration.",
"operationId": "getDistinctDocumentVariableNames"
}
},
"/repository/checkReadable": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The path to check.",
"required": false,
"type": "string",
"name": "path",
"in": "query"
}
],
"tags": [
"repository"
],
"summary": "Checks if the repository path is readable.",
"consumes": [
"application/json"
],
"operationId": "checkRepositoryReadable"
}
},
"/bpm/management/business/holidays/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
}
}
},
"description": "Requires the BPM_HOLIDAYS_CONFIGURE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
},
"description": "Modified holidays.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Update business holidays.",
"consumes": [
"application/json"
],
"operationId": "updateHolidaysRest"
}
},
"/dashboarddesigner/charts/ul": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The chart ID.",
"required": true,
"type": "string",
"name": "id",
"in": "formData"
}
],
"tags": [
"dashboarddesigner"
],
"summary": "Unlock a chart that is currently locked by someone else, potentially causing them to lose work.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "unlockChartDesign"
}
},
"/category": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DOC_CATEGORY_DELETE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Representation of a DocFinity category."
},
"description": "The category to delete.",
"required": false,
"name": "category",
"in": "body"
}
],
"tags": [
"category"
],
"summary": "Delete the category specified.",
"consumes": [
"application/json"
],
"operationId": "deleteCategoryRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Representation of a DocFinity category."
},
"type": "array"
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supported filters include: id, name, categoryName, status, groupId, and documentTypeName.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Get categories using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getCategoriesByCriteriaRest"
}
},
"/dbconn/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
}
}
},
"description": "Requires the DATABASECONNECTION_MANAGE feature rights.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/DatabaseConnectionDTO"
},
"type": "array"
},
"description": "The Database connection DTOs to add.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dbconn"
],
"summary": "Add database connections.",
"consumes": [
"application/json"
],
"operationId": "addDatabaseConnections"
}
},
"/datasources/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of a data source."
}
}
},
"description": "Requires MANAGE_DATASOURCE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The definition of a data source."
},
"type": "array"
},
"description": "The datasource dtos to be updated.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Update datasources in the system.",
"consumes": [
"application/json"
],
"operationId": "updateDatasourcesRest"
}
},
"/groups/associations": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged search result for groups."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object representing a group."
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Retrieve the groups associated with a specific set of entities based on the entity type and ordered in association priority",
"consumes": [
"application/json"
],
"operationId": "getGroupEntityAssociations"
}
},
"/datasources/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of a data source."
}
}
},
"description": "Requires MANAGE_DATASOURCE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The definition of a data source."
},
"type": "array"
},
"description": "The datasource dtos to be added.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Add datasource to the system.",
"consumes": [
"application/json"
],
"operationId": "addDatasourcesRest"
}
},
"/form/designer/deactivate/{id}": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the FORM_DESIGN_DEACTIVATE feature right.",
"parameters": [
{
"description": "Form id to deactivate.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"tags": [
"formdesigner"
],
"summary": "Deactivates the specified form design, making it unavailable for users. Any currently running forms will be completed as normal, but no new form instances may be started.",
"consumes": [
"application/json"
],
"operationId": "deactivateDesign"
}
},
"/dashboarddesigner/macro": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object containing the information needed in order to execute a macro."
},
"description": "The macro to execute and any required inputs to that macro.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Execute a macro for use in a dashboard input.",
"consumes": [
"application/json"
],
"operationId": "executeMacro"
}
},
"/wsdlurl/describe": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WebserviceDTO"
}
}
},
"description": "Requires the WSDL_URL_VIEW feature right.",
"parameters": [
{
"description": "The id of the WSDL URL webservice.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"wsdlurl"
],
"summary": "Describes the webservice represented by the specified WsdlUrl id. ",
"operationId": "describeWebservice"
}
},
"/indexing/batches/delete": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of the following feature rights: BATCH_MANAGE.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A batch of documents."
},
"type": "array"
},
"description": "Batches to delete.",
"required": false,
"name": "batches",
"in": "body"
}
],
"tags": [
"indexing"
],
"summary": "Delete batches from the system.",
"consumes": [
"application/json"
],
"operationId": "deleteBatchesRest"
}
},
"/bpm/client/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "",
"parameters": [
{
"description": "The process model id to use to seek through the pages of process models.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The required size of package items, Valid values are -1, 0 or 1.",
"format": "int32",
"required": false,
"in": "query",
"type": "integer",
"name": "requiredItems"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Find the page location (page number) of the specified process model across all pages of process models. ",
"operationId": "getPageIndexForProcessModel"
}
},
"/hsm/plugins": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The HSM action plugin dto."
}
}
},
"description": "Requires the following feature right: HSM_EDIT",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"hsm"
],
"summary": "Get the HSM plugins configured in the system",
"operationId": "getHsmActionPlugins"
}
},
"/ldap/sync/results": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DTO describing the results of synchronization between an Ldap and DocFinity entity."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Get information from the synchronized users. This method will only return changes in the users between this current synchronization and the previous synchronization. It will not return all users in the LDAP system.",
"consumes": [
"application/json"
],
"operationId": "getSynchronizationResults"
}
},
"/user/password/change": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
}
}
},
"description": "Requires the USERS_CREATE or USERS_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array"
},
"description": "The user DTOs that require password modifications.",
"required": false,
"name": "users",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Change password for users.",
"consumes": [
"application/json"
],
"operationId": "changePasswordForUsers"
}
},
"/groups/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The group name to check",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"groups"
],
"summary": "Check whether the specified group name is available.",
"consumes": [
"text/plain"
],
"operationId": "isGroupNameAvailable"
}
},
"/dashboarddesigner/dash/bydash": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"type": "array"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get a listing of all dashboards that drill down to the specified dashboard.",
"consumes": [
"application/json"
],
"operationId": "getDashboardDrillDownReferences"
}
},
"/bpm/management/roles/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"description": "Requires BPM_ROLE_PROXY_CONFIGURE feature right. ",
"parameters": [
{
"description": "The role id to use to seek through the pages of roles.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: roleName.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Find the page location (page number) of the specified role across all pages of roles.",
"consumes": [
"application/json"
],
"operationId": "getPageIndexForRole"
}
},
"/importer/seek": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The importer id to use to seek through the pages of importer.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use. + The fields that can be used are : name, processType(INDEX/OBJECT/EMAIL/COLD/REPORT), running(true/false), pending(true/false)",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. The fields that can be used are : ids (allows multiple) , name, status(ACTIVE/INACTIVE), processType(INDEX/OBJECT/EMAIL/COLD/REPORT), running(true/false), pending(true/false), excludeNames(allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"importer"
],
"description": "",
"summary": "Find the page location (page number) of the specified importer across all pages of importer. ",
"operationId": "getPageIndexForImporter"
}
},
"/datastore": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DATA_STORE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/DataStore data used to configure datastores for the system."
},
"description": "The dto of the datastore to delete.",
"required": false,
"name": "dto",
"in": "body"
}
],
"tags": [
"datastore"
],
"summary": "The datastore to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteDataStoreRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, DATA_STORE_MANAGE, FORM_DESIGNER.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the sorting on the following : name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports the following fields: id (allows multiple), name (allows multiple), excludeNames (allows multiple).",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"datastore"
],
"summary": "Get datastores using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDataStoresByCriteriaRest"
}
},
"/indexing/batches": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A batch of documents."
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: SCAN, FILE_UPLOAD, BATCH_MANAGE, RECEIVE_BATCH.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A batch of documents."
},
"type": "array"
},
"description": "One or more batches to add to the system.",
"required": false,
"name": "batches",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"indexing"
],
"summary": "Add batches to the system.",
"consumes": [
"application/json"
],
"operationId": "addBatches"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires the BATCH_MANAGE feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.Supports the following fields: name, documentCount, checkedOutBy, checkedOutDate, createdOn",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports: name, checkedOutBy, checkedOutDate, createdOn",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"indexing"
],
"summary": "Get batches using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getBatchesRest"
}
},
"/scansetting": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the SCAN_SETTING_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Representation of scan settings."
},
"type": "array"
},
"description": "The scan settings to delete.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"scansetting"
],
"summary": "Delete the scan settings specified.",
"consumes": [
"application/json"
],
"operationId": "deleteScanSettingsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, SCAN_SETTING_MANAGE",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use, which include id, name, and excludeNames.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Get scan settings using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getScanSettingsByCriteriaRest"
}
},
"/groups/members/save": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of the following feature rights: GROUPS_CREATE, GROUPS_EDIT",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a user assignment to a group."
},
"type": "array"
},
"description": "Items to add or delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"groups"
],
"summary": "Add or delete group members.",
"consumes": [
"application/json"
],
"operationId": "updateGroupMembersRest"
}
},
"/bpm/management/shifts/{id}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The DTO object for a Shift."
}
}
},
"description": "",
"parameters": [
{
"description": "id of shift to return.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Returns a specific shift.",
"consumes": [
"application/json"
],
"operationId": "getShiftById"
}
},
"/dashboarddesigner/charts/saveas": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The representation of a Chart object."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that contains all the data necessary to invoke a save as operation on a chart."
},
"description": "Object containing instructions for how to save the chart.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Make a copy of a chart, or overwrite another chart.",
"consumes": [
"application/json"
],
"operationId": "saveChartAs"
}
},
"/exporter/admin/server": {
"put": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
},
"description": "The exporter server dto to be upated.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Update exporter server to the system.",
"consumes": [
"application/json"
],
"operationId": "updateExporterServer"
},
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
},
"description": "The exporter server dto to be added.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Add exporter server to the system.",
"consumes": [
"application/json"
],
"operationId": "addExporterServer"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
},
"description": "The exporter server dto to be deleted.",
"required": false,
"name": "dtos",
"in": "body"
}
],
"tags": [
"exporteradmin"
],
"summary": "The exporter server to delete.",
"consumes": [
"application/json"
],
"operationId": "deleteExporterServer"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Get default exporter server.",
"operationId": "getDefaultExporterServer"
}
},
"/printfax/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that defines print or fax server."
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"printfax"
],
"summary": "Test the connection to the provided print/fax server.",
"consumes": [
"application/json"
],
"operationId": "testConnection"
}
},
"/form/checkin": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "If the instance is not checked out this method does nothing.",
"parameters": [
{
"description": "The form instance id.",
"required": false,
"type": "string",
"name": "id",
"in": "query"
}
],
"tags": [
"form"
],
"summary": "Checks in the form instance with specified id.",
"consumes": [
"application/json"
],
"operationId": "checkInFormInstance"
}
},
"/document/search/checklist/execute": {
"post": {
"operationId": "searchDocumentsByChecklist",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ChecklistSearchResultDTO"
}
}
},
"parameters": [
{
"schema": {
"$ref": "#/definitions/SearchExecutionWrapperDTO"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"document"
]
}
},
"/system/transfer/status": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/SystemTransferStatusDTO"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"systemtransfer"
],
"summary": "Returns the progress for the last scheduled system transfer import.",
"operationId": "getImportStatus"
}
},
"/license/metrics": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Amalgamated view of license usage vs availability."
}
}
},
"description": "Requires the MANAGE_LICENSES feature right",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Returns an amalgamated snapshot of license usage relative to the total number of licenses available.",
"operationId": "getGlobalSessionMetrics"
}
},
"/documentType/update/batch": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: DOC_TYPE_EDIT, DOC_TYPE_CREATE.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
},
"description": "The document type DTOs to update.",
"required": false,
"name": "documentTypes",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Update the document types.",
"consumes": [
"application/json"
],
"operationId": "updateDocumentTypes"
}
},
"/importer/status": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the IMPORTER_START_STOP feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A command object used to start or stop an importer."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"importer"
],
"summary": "Start or stop an importer.",
"consumes": [
"application/json"
],
"operationId": "applyImporterState"
}
},
"/editing/cancel": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The result of attempting to cancel an edit for a document."
},
"type": "array"
}
}
},
"description": "Requires the EDITING_CANCEL_ANY_EDIT feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The document IDs of the edit locks to cancel.",
"required": false,
"name": "ids",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"editing"
],
"summary": "Cancel the specified edits. Note that this method works off of document Ids, not edit lock Ids.",
"consumes": [
"application/json"
],
"operationId": "cancelCheckOuts"
}
},
"/validator/references": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/EntityReferenceDTO"
},
"type": "array"
}
}
},
"description": "Requires one of the following feature rights: VALIDATOR_MANAGE.",
"parameters": [
{
"description": "The validator id to locate references in the system.",
"required": true,
"type": "string",
"name": "validatorId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"validator"
],
"summary": "Find all places in the system that reference the provided validator.",
"operationId": "getValidatorReferences"
}
},
"/documentType/seek/name": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int64"
}
}
},
"parameters": [
{
"description": "The category name to use to seek through the pages of document types.",
"required": true,
"type": "string",
"name": "categoryName",
"in": "query"
},
{
"description": "The document type name to use to seek through the pages of document types.",
"required": true,
"type": "string",
"name": "name",
"in": "query"
},
{
"description": "The maximum results for a page.",
"format": "int32",
"required": true,
"in": "query",
"type": "integer",
"name": "pageSize"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
}
],
"tags": [
"documentType"
],
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, SEARCHES_CREATE, SEARCHES_DELETE, SEARCHES_EDIT, DOC_TYPE_EDIT, DOC_TYPE_CREATE.",
"summary": "Find the page location (page number) of the specified document type across all pages of document type.",
"operationId": "getPageIndexForDocumentTypeByName"
}
},
"/overlays/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Object that represents a document overlay."
}
}
},
"description": "Requires the following feature right: OVERLAY_MANAGE",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Object that represents a document overlay."
},
"description": "The overlay to add.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"overlays"
],
"summary": "Add an overlay.",
"consumes": [
"application/json"
],
"operationId": "addOverlay"
}
},
"/hotkeys/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A representation of the HotKey entity for use by the web service layer."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A representation of the HotKey entity for use by the web service layer."
},
"description": "HotKey to update.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"hotkeys"
],
"summary": "Update the HotKey.",
"consumes": [
"application/json"
],
"operationId": "updateHotKey"
}
},
"/datasources/check": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"description": "",
"parameters": [
{
"description": "The datasource name to check",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Check whether the specified datasource name is available.",
"consumes": [
"text/plain"
],
"operationId": "isDatasourceNameAvailable"
}
},
"/dashboards/dash/{id}/prompts": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": "array"
}
}
},
"description": "Requires either the DASHBOARDS_VIEW or DASHBOARDS_MANGE feature right.",
"parameters": [
{
"description": "The ID of the dashboard.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get the prompts for a dashboard. Returns our generic prompt list.",
"operationId": "getPrompts"
}
},
"/scansetting/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/Representation of scan settings."
},
"type": "array"
}
}
},
"description": "Requires the SCAN_SETTING_MANAGE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/Representation of scan settings."
},
"type": "array"
},
"description": "The ScanSetting DTOs to update.",
"required": false,
"name": "scanSettings",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"scansetting"
],
"summary": "Update the scanSettings.",
"consumes": [
"application/json"
],
"operationId": "updateScanSettingsRest"
}
},
"/datasources/plugin/types": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A plugin DTO for Datasources."
}
}
},
"description": "Requires MANAGE_DATASOURCE feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"datasources"
],
"summary": "Get the datasource types in the system.",
"consumes": [
"application/json"
],
"operationId": "getDatasourceTypes"
}
},
"/bpm/client/storedprocedures": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of a stored procedure stored in a database."
}
}
},
"description": "Requires one of the following SEARCHES_CREATE or SEARCHES_EDIT or BPM_DESIGNER or DATASOURCE_MANAGE or INDEX or FORMS or FORM_DESIGNER or IMPORTER_CREATE or IMPORTER_EDIT or BPM_QUEUE_VIEWS_CONFIGURE or DASHBOARDS_MANAGE or DASHBOARDS_VIEW feature rights",
"parameters": [
{
"description": "The database connection dto.",
"required": false,
"type": "string",
"name": "databaseConnectionId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Get the stored procedures in the system referred to by the database connection.",
"operationId": "getStoredProcedures"
}
},
"/repository/getDiskInfoByFunction/{type}": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource."
}
}
},
"description": "",
"parameters": [
{
"description": "The function of the repository.",
"required": true,
"type": "string",
"name": "type",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get the disk information for the given function.",
"consumes": [
"application/json"
],
"operationId": "getRepositoryDiskInformationByFunctionRest"
}
},
"/form/designer/latest": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A data transfer object representing a form design."
}
}
},
"description": "",
"parameters": [
{
"description": "The name of the form design to retrieve.",
"required": false,
"type": "string",
"name": "name",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"formdesigner"
],
"summary": "Retrieve the currently active form design with the given name. If no active version exists, this method will return the working copy version. If no form exists with this name, it will return null.",
"consumes": [
"application/json"
],
"operationId": "getActiveOrWorkingCopyFormDesignByName"
}
},
"/bpm/management/business/hours": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The DTO object for a business day."
},
"type": "array"
}
}
},
"description": "Requires the BPM_BUSINESS_HOURS_CONFIGURE feature right.",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/The DTO object for a business day."
},
"type": "array"
},
"description": "The business hours to update.",
"required": false,
"name": "days",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Update business hours.",
"consumes": [
"application/json"
],
"operationId": "updateHours"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The DTO object for a business day."
},
"type": "array"
}
}
},
"description": "Requires the BPM_BUSINESS_HOURS_CONFIGURE feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Get business hours.",
"operationId": "getHours"
}
},
"/dashboards/dash/grouped/category": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A generic object that holds a collection of grouped items to be returned via JSON. Generally used when retrieving items in conjunction with a Kendo DataSource grouped by a String name."
}
}
},
"description": "Requires the DASHBOARDS_VIEW feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"dashboards"
],
"summary": "Get a list of dashboards to which the current user has group access, grouped by category.",
"operationId": "getDashboardsByCategory"
}
},
"/form/designer/list": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: FORM_DESIGNER, SEARCHES_CREATE, or SEARCHES_EDIT.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use. Valid value is name.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Valid values are id, name, version, and status.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"formdesigner"
],
"summary": "Retrieve one result for each active or working copy form design.",
"consumes": [
"application/json"
],
"operationId": "getActiveOrWorkingCopyDesignsRest"
}
},
"/records/docType": {
"put": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires one of the following feature rights: MANAGE_RETENTION_POLICIES, OVERRIDE_RETENTION_POLICIES, or SYSTEM_TRANSFER_IMPORT.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "retentionPolicyId",
"in": "query"
},
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "documentTypeId",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"records"
],
"summary": "Assign retention policy to a document type. If no retention policy is specified, then the default retention policy will be used and associated to the specified document type. Document type is required.",
"consumes": [
"application/json"
],
"operationId": "assignDocumentTypesToRetentionPolicyRest"
}
},
"/importer/narrative/test/purge": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires at least one of the following permissions: IMPORTER_START_STOP, IMPORTER_CREATE, IMPORTER_EDIT, IMPORTER_DELETE.",
"parameters": [
{
"description": "The narrative test id purge.",
"required": true,
"type": "string",
"name": "narrativeTestId",
"in": "formData"
}
],
"tags": [
"importer"
],
"summary": "Purge narrative test results.",
"consumes": [
"application/x-www-form-urlencoded"
],
"operationId": "purgeTestArtifact"
}
},
"/bpm/client/checkout/job/{jobId}": {
"get": {
"operationId": "checkOutJobResult",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CheckOutJobResultDTO"
}
}
},
"parameters": [
{
"required": true,
"type": "string",
"name": "jobId",
"in": "path"
}
],
"tags": [
"bpmclient"
]
}
},
"/category/hierarchy": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "This method is designed to work with the Kendo TreeList widget. It returns data in a common format for both Categories and Document Types. The type of data returned by this method changes depending on the parameters that are passed in. To get Categories, omit the 'id'query string parameter. To get Document Types, provide the 'id' query string parameter. This method also changes its behavior based on the filters applied. If a 'groupId' filter is supplied, this method will return only the categories/document types that are NOT currently assigned to this group (more work needed there to standardize).",
"parameters": [
{
"description": "Filters to apply. Supports the following fields: groupId, categoryName, documentTypeName",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The category ID. If supplied, this method will return document types in this category.",
"required": false,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"category"
],
"summary": "Get the document hierarchy. This method does not return deleted items.",
"consumes": [
"application/json"
],
"operationId": "getHierarchy"
}
},
"/search/enterprise/test/ocr": {
"get": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"required": false,
"type": "string",
"name": "uri",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"search"
],
"summary": "Test enterprise OCR server URI.",
"consumes": [
"application/json"
],
"operationId": "testOcrWebService"
}
},
"/documentType": {
"post": {
"operationId": "getDocumentTypes",
"responses": {
"200": {
"headers": {},
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
}
}
},
"parameters": [],
"tags": [
"documentType"
]
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the DOC_TYPE_DELETE feature right.",
"parameters": [
{
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "The document types to delete.",
"required": false,
"name": "ids",
"in": "body"
}
],
"tags": [
"documentType"
],
"summary": "Delete the document types specified.",
"consumes": [
"application/json"
],
"operationId": "deleteDocumentTypes"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: SYSTEM_TRANSFER_EXPORT, SEARCHES_CREATE, SEARCHES_DELETE, SEARCHES_EDIT, DOC_TYPE_EDIT, DOC_TYPE_CREATE.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use, which include id, name, excludeNames, categoryId, categoryName, documentTypeStatus and groupId.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"documentType"
],
"summary": "Get document types using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getDocumentTypesByCriteriaRest"
}
},
"/ldap/sync/errors": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Detached object representation of persisted LDAP synchronization errors."
}
}
},
"description": "",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Get information about Synchronization errors. This method will only return changes in the users between this current synchronization and the previous synchronization. Therefore, if no errors occur during synchronization, this method will return a null.",
"consumes": [
"application/json"
],
"operationId": "getSynchronizationErrors"
}
},
"/docsecurity/permissionTypes": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A document permission type."
},
"type": "array"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Get all of the possible document permission types.",
"operationId": "getPermissionTypesRest"
}
},
"/bpm/management/views/update": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/View data used to configure job views for the system."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: BPM_QUEUE_VIEWS_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/View data used to configure job views for the system."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Update one or more views to the system.",
"consumes": [
"application/json"
],
"operationId": "updateViewsRest"
}
},
"/wsdlurl": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A representation of the wsdl url object that can be applied to get requests."
}
}
},
"description": "Requires one of PRINTFAX_MANAGE_SERVERS, FAX_MANAGE_SERVERS feature rights.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A representation of the wsdl url object that can be applied to get requests."
},
"description": "The WSDL URL object to save.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"wsdlurl"
],
"summary": "Save the WSDL URL webservice.",
"consumes": [
"application/json"
],
"operationId": "saveWsdlUrl"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the WSDL_URL_DELETE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/A representation of the wsdl url object that can be applied to get requests."
},
"description": "The dto of the WSDL URL webservice to delete.",
"required": true,
"name": "wsdlUrlDto",
"in": "body"
}
],
"tags": [
"wsdlurl"
],
"summary": "Delete WSDL URL webservices.",
"consumes": [
"application/json"
],
"operationId": "deleteWsdlUrlRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WsdlServicesDTO"
}
}
},
"description": "Requires the WSDL_URL_VIEW, BPM_DESIGNER, or DATASOURCE_MANAGER feature right.",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"wsdlurl"
],
"summary": "Gets the webservice configuration represented by the specified WsdlUrl id. ",
"consumes": [
"application/json"
],
"operationId": "getWsdlUrlsByCriteriaRest"
}
},
"/bpm/management/business/holidays": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/The dto representation of a holiday."
},
"type": "array"
}
}
},
"description": "Requires the BPM_HOLIDAYS_CONFIGURE feature right.",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Get business holidays.",
"operationId": "getHolidays"
}
},
"/groups/assign": {
"post": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing a group assignment."
},
"type": "array"
},
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"groups"
],
"summary": "Assign or remove the groups associated with a specific set of entities based on the entity type.",
"consumes": [
"application/json"
],
"operationId": "assignGroups"
}
},
"/dashboarddesigner/render/dashboardchartable": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/An object defining the information needed to render a chart on a dashboard."
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/An object that contains the data necessary to preview a chart on a dashboard."
},
"description": "The arguments needed to render a chart preview.",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"dashboarddesigner"
],
"summary": "Render a preview of a chart on a dashboard while in dashboard configuration.",
"consumes": [
"application/json"
],
"operationId": "renderDashboardChartable"
}
},
"/exporter/admin/test": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
}
}
},
"description": "",
"parameters": [
{
"schema": {
"$ref": "#/definitions/Configuration details for an exporter server."
},
"description": "The exporter server dto for connection verification.",
"required": false,
"name": "exporterServerDto",
"in": "body"
}
],
"tags": [
"exporteradmin"
],
"summary": "Test exporter server details.",
"consumes": [
"application/json"
],
"operationId": "testConnection"
}
},
"/repository/moveRenderings": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "boolean"
}
}
},
"parameters": [],
"tags": [
"repository"
],
"description": "Requires one of the REPOSITORY_CREATE, REPOSITORY_EDIT, or REPOSITORY_DELETE feature rights.",
"summary": "Move all renderings to the renderings repository.",
"operationId": "moveAllRenderingsToRenderingsRepository"
}
},
"/ldap/sync/stats": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Transfer class for details about a previous synchronziation attempt."
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"ldap"
],
"summary": "Return a collection of numeric stats on the last synchronization result.",
"operationId": "getDerivedSynchronizationStats"
}
},
"/exporter/admin/add": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
}
}
},
"description": "Requires EXPORTER_PROFILE_MANAGE feature right.",
"parameters": [
{
"schema": {
"$ref": "#/definitions/The definition of an exporter profile."
},
"description": "The exporter profile dto to be added.",
"required": false,
"name": "dto",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"exporteradmin"
],
"summary": "Add exporter profile to the system.",
"consumes": [
"application/json"
],
"operationId": "addExporterProfileRest"
}
},
"/hotkeys/reset/id/{id}": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A representation of the HotKey entity for use by the web service layer."
}
}
},
"description": "",
"parameters": [
{
"description": "Id of the HotKey to revert.",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"produces": [
"application/json"
],
"tags": [
"hotkeys"
],
"summary": "Revert the supplied hot key to its default value.",
"operationId": "resetToDefault"
}
},
"/docsecurity": {
"post": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/An object representing the document security configuration for 1 group and 1 document type."
},
"type": "array"
}
}
},
"description": "Requires the following feature right: DOC_TYPE_SECURITY",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing the document security configuration for 1 group and 1 document type."
},
"type": "array"
},
"description": "One or more security configurations",
"required": false,
"name": "body",
"in": "body"
}
],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Save or delete the document security configuration for a set of groups and document types.",
"consumes": [
"application/json"
],
"operationId": "saveDocumentTypeGroups"
},
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: DOC_TYPE_SECURITY",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/An object representing the document security configuration for 1 group and 1 document type."
},
"type": "array"
},
"description": "One or more security configurations to delete",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"docsecurity"
],
"summary": "Delete the provided document security configurations.",
"consumes": [
"application/json"
],
"operationId": "deleteDocumentTypeGroupsRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged result for document type group assignments."
}
}
},
"description": "There are 2 main uses for this method: getting the security configuration for a specific group, or a specific document type. To query for a group, pass a filter for the groupId field, containing the ID of the group as the filter value. To query for a document type, pass a filter for the documentTypeId field, containing the ID of the document type as the filter value.",
"parameters": [
{
"description": "Filters to apply. Applicable values are groupId (allows multiple) and documentTypeId (allows multiple)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "Sorts to apply",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"docsecurity"
],
"summary": "Get a page of document security configuration for a group or a document type.",
"consumes": [
"application/json"
],
"operationId": "getDocumentSecurity"
}
},
"/bpm/client": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "Requires one of the following feature rights: BPM_DESIGNER, IMPORTER_CREATE, IMPORTER_EDIT, SYSTEM_TRANSFER_EXPORT, BPM_MODEL_ASSIGN",
"parameters": [
{
"description": "A Sorts object that specifies the sorts to use.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Supports : name(multiple), version(multiple), packageItemType(multiple), status(multiple),highestOnly(boolean)",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmclient"
],
"summary": "Get process models using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getProcessModelsByCriteriaRest"
}
},
"/license/pool/user": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/LicensePoolDTO"
}
}
},
"description": "",
"parameters": [],
"produces": [
"application/json"
],
"tags": [
"license"
],
"summary": "Returns the user license pools.",
"operationId": "getUserLicensePools"
}
},
"/dashboarddesigner/dash/drillcount": {
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"description": "Requires the DASHBOARDS_MANAGE feature right.",
"parameters": [
{
"description": "The dashboard ID.",
"required": true,
"type": "string",
"name": "id",
"in": "query"
}
],
"produces": [
"text/plain"
],
"tags": [
"dashboarddesigner"
],
"summary": "Get the number of dashboards that drill down to the specified dashboard.",
"operationId": "getCountOfDashboardDrillDownReferences"
}
},
"/bpm/management/roles": {
"delete": {
"responses": {
"default": {
"description": "successful operation"
}
},
"description": "Requires the following feature right: BPM_ROLE_PROXY_CONFIGURE",
"parameters": [
{
"schema": {
"items": {
"$ref": "#/definitions/A role used in business process management."
},
"type": "array"
},
"description": "One or more roles to delete.",
"required": false,
"name": "body",
"in": "body"
}
],
"tags": [
"bpmmanagement"
],
"summary": "Delete one or more roles.",
"consumes": [
"application/json"
],
"operationId": "deleteRolesRest"
},
"get": {
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/A paged collection of search results for some entity."
}
}
},
"description": "",
"parameters": [
{
"description": "You can only sort on roleName.",
"required": false,
"type": "string",
"name": "sort",
"in": "query"
},
{
"description": "A Filters object that specifies the filters to use. Possible filter fields include: roleName(multiple), excludeNames(multiple), and roleHolder.",
"required": false,
"type": "string",
"name": "filter",
"in": "query"
},
{
"description": "The start index.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "startIndex"
},
{
"description": "The maximum number of results to return.",
"format": "int32",
"default": "0",
"required": false,
"in": "query",
"type": "integer",
"name": "pageSize"
}
],
"produces": [
"application/json"
],
"tags": [
"bpmmanagement"
],
"summary": "Get Roles using the provided sort, filter, and paging settings.",
"consumes": [
"application/json"
],
"operationId": "getRolesRest"
}
}
},
"definitions": {
"DocumentType data used to configure document types for the system.": {
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string",
"description": "The type of document type."
},
"fullText": {
"default": false,
"type": "boolean",
"description": "Flag to indicate document type is full texted."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The flag to indicate if document type is marked for deletion."
},
"description": {
"type": "string",
"description": "The description of the document type."
},
"retentionPolicy": {
"description": "The retention policy associated with the document type.",
"$ref": "#/definitions/RetentionPolicyDTO"
},
"categoryId": {
"type": "string",
"description": "The ID of the category the document type is associated with."
},
"version": {
"default": false,
"type": "boolean",
"description": "The version of the document type."
},
"documentCount": {
"type": "integer",
"description": "The count of the documents associated with the document type.",
"format": "int64"
},
"categoryName": {
"type": "string",
"description": "The name of the category the document type is associated with."
},
"id": {
"type": "string",
"description": "The ID of the document type."
},
"name": {
"type": "string",
"description": "The name of the document type."
}
}
},
"The representation of the relationship between a document type and a set of scan settings.": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "string",
"description": "The unique identifier of the document type."
},
"scanSettingId": {
"type": "string",
"description": "The unique identifier of the scan setting."
},
"id": {
"type": "string",
"description": "The unique identifier of the document type to scan setting relationshiop."
},
"documentTypeName": {
"type": "string",
"description": "The name of the document type."
},
"scanSettingName": {
"type": "string",
"description": "The name of the scan setting."
}
}
},
"An object representing a user assignment to a group.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The markedForDelete flag."
},
"groupIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "The group IDs."
},
"users": {
"items": {
"$ref": "#/definitions/UserDTO"
},
"type": "array",
"description": "The users."
}
}
},
"FullTextDTO": {
"type": "object",
"properties": {
"highlight": {
"type": "string"
},
"lastIndexed": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"majorVersion": {
"type": "integer",
"format": "int32"
}
}
},
"ExternalFileStoreProp": {
"type": "object",
"properties": {
"keyValue": {
"type": "string"
},
"keyName": {
"type": "string"
},
"fileStore": {
"$ref": "#/definitions/FileStore"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"A validation result containing warnings and errors.": {
"type": "object",
"properties": {
"errors": {
"items": {
"$ref": "#/definitions/A single validation error or warning."
},
"type": "array",
"description": "The list of validation errors and warnings."
}
}
},
"A pie chart.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"User to View association configuration data.": {
"type": "object",
"properties": {
"groupName": {
"type": "string",
"description": "The group name of User to View association configuration data."
},
"viewId": {
"type": "string",
"description": "The view id of User to View association configuration data."
},
"id": {
"type": "string",
"description": "The id of User to View association configuration data."
}
}
},
"The job filter configuration data": {
"type": "object",
"properties": {
"comparator": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO",
"LIKE",
"NOT_LIKE",
"AND",
"OR"
],
"type": "string",
"description": "The job filter comparator associated with the job filter data."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type associated with the job filter data."
},
"filterValueTypeProperty": {
"type": "string",
"description": "The filter property value type associated with the job filter data."
},
"variables": {
"items": {
"type": "string"
},
"type": "array",
"description": "The variables associated with the job filter data."
},
"filterType": {
"enum": [
"JOB_PROPERTY",
"PROCESS_INSTANCE_VARIABLE",
"PACKAGE_ITEM_PROPERTY",
"PROMPT_RESULT"
],
"type": "string",
"description": "The filter type associated with the job filter data."
},
"filterValueType": {
"enum": [
"JOB_PROPERTY",
"PACKAGE_ITEM_PROPERTY",
"PROCESS_INSTANCE_VARIABLE",
"STATIC_VALUE",
"PROMPT_RESULT"
],
"type": "string",
"description": "The filter value type associated with the job filter data."
},
"filterTypeProperty": {
"type": "string",
"description": "The filter property type associated with the job filter data."
},
"value2": {
"type": "string",
"description": "The value2 parameter associated with the job filter data."
},
"value1": {
"type": "string",
"description": "The value1 property associated with the job filter data."
},
"id": {
"type": "string",
"description": "The id associated with the job filter data."
}
}
},
"Metadata": {
"required": [
"currencyLocale",
"description",
"isCollection",
"isCurrency",
"name",
"shortName"
],
"type": "object",
"properties": {
"isCollection": {
"default": false,
"type": "boolean"
},
"documentTypeMetadatas": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"type": "array"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"description": {
"type": "string"
},
"dispositionConditions": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DispositionCondition"
},
"type": "array"
},
"isCurrency": {
"default": false,
"type": "boolean"
},
"validateReservedPrefix": {
"default": false,
"type": "boolean"
},
"collectionBased": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"currencyLocale": {
"type": "string"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string"
},
"decimalPrecision": {
"type": "integer",
"format": "int32"
},
"searchMetadatas": {
"items": {
"$ref": "#/definitions/SearchParameter"
},
"type": "array"
},
"searchResultMetadatas": {
"items": {
"$ref": "#/definitions/SearchResultColumn"
},
"type": "array"
},
"shortName": {
"type": "string"
},
"markedForRecreate": {
"default": false,
"type": "boolean"
},
"securityFilters": {
"items": {
"$ref": "#/definitions/SecurityFilter"
},
"type": "array"
},
"id": {
"type": "string"
},
"searchSortOrderMetadatas": {
"items": {
"$ref": "#/definitions/SearchSortOrder"
},
"type": "array"
},
"name": {
"type": "string"
}
}
},
"A transition from a chart to another object: a chart, dashboard, or URL.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The order of the drill down.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"chartInputs": {
"items": {
"$ref": "#/definitions/An input mapping for a drill down to a chart."
},
"type": "array",
"description": "The input mappings for the target chart, set only when type is CHART."
},
"dashboardChartableId": {
"type": "string",
"description": "The ID of the DashboardChartable that owns this drill down."
},
"dashboardName": {
"type": "string",
"description": "The name of the target dashboard, set only when type is DASHBOARD."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether this item is in a valid state."
},
"chartableName": {
"type": "string",
"description": "The name of the target chart, set only when type is CHART."
},
"url": {
"type": "string",
"description": "The target URL, set only when type is URL."
},
"chartableId": {
"type": "string",
"description": "The ID of the target chart, set only when type is CHART."
},
"chartableType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The type of the target chart, set only when type is CHART."
},
"dashboardId": {
"type": "string",
"description": "The ID of the target dashboard, set only when type is DASHBOARD."
},
"dashboardInputs": {
"items": {
"$ref": "#/definitions/An input mapping for a drill down to a dashboard."
},
"type": "array",
"description": "The input mappings for the target dashboard, set only when type is DASHBOARD."
},
"type": {
"enum": [
"URL",
"DASHBOARD",
"CHART"
],
"type": "string",
"description": "The type of drill down."
},
"id": {
"type": "string",
"description": "The ID of the DrillDown."
}
}
},
"A bar chart.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"ServerNodeDTO": {
"type": "object",
"properties": {
"nodeIdentifier": {
"type": "string"
}
}
},
"The representation of the tree filter to associate with the search.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of this filter with respect to other filters in the search.",
"format": "int32"
},
"sortOrder": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string",
"description": "The sort order associated with this tree filter."
},
"searchId": {
"type": "string",
"description": "The ID of the search."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute associated to this tree filter."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication as to whether or not to delete this tree filter from the search."
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The type of the tree filter attribute, describing what piece of data to which this tree filter is associated."
},
"id": {
"type": "string",
"description": "The ID of the tree filter associated with the search."
},
"metadata": {
"description": "The metadata object associated to this tree filter. This will be NULL if the filter is associated to a non-metadata piece of data.",
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
}
}
},
"DatasourceIntent": {
"required": [
"datasource",
"intent"
],
"type": "object",
"properties": {
"intent": {
"enum": [
"COMPLEX_TABLE",
"SIMPLE"
],
"type": "string"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"datasource": {
"$ref": "#/definitions/Datasource"
}
}
},
"A batch of documents.": {
"type": "object",
"properties": {
"documentIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "The IDs of unindexed documents to add to this batch."
},
"createdBy": {
"type": "string",
"description": "The username of the user who created this batch."
},
"name": {
"type": "string",
"description": "The name of the batch. When creating batches, you can omit this field to have the name generated automatically."
},
"checkedOutByLastName": {
"type": "string",
"description": "The last name of the user who has this batch checked out."
},
"batchGroupIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "The IDs of the groups who have access to this batch. You must specify one ore more group IDs when creating a new batch."
},
"createdOn": {
"type": "string",
"description": "The date/time that this batch was created.",
"format": "date-time"
},
"checkedOut": {
"default": false,
"type": "boolean",
"description": "Whether this batch is currently checked out."
},
"id": {
"type": "string",
"description": "The ID of the batch."
},
"nameUserDefined": {
"type": "string",
"description": "When automatically generating names, this field represents the user defined text portion of the batch name."
},
"checkedOutDate": {
"type": "string",
"description": "The date/time that this batch was checked out.",
"format": "date-time"
},
"checkedOutBy": {
"type": "string",
"description": "The username of the user who has this batch checked out."
},
"checkedInDate": {
"type": "string",
"description": "The date/time that this batch was last checked in.",
"format": "date-time"
},
"checkedOutByFirstName": {
"type": "string",
"description": "The first name of the user who has this batch checked out."
},
"batchGroupNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "The names of all groups assigned access to this batch. Read-only."
},
"documentCount": {
"type": "integer",
"description": "The number of documents in the batch.",
"format": "int64"
},
"description": {
"type": "string",
"description": "The description of the batch."
}
}
},
"Document preview from search results.": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Category name"
},
"displayName": {
"type": "string",
"description": "Display name"
},
"documentType": {
"type": "string",
"description": "Document type name"
}
}
},
"LicenseDTO": {
"type": "object",
"properties": {
"dateIssued": {
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
},
"numberOfLicenses": {
"type": "string"
},
"expirationDate": {
"type": "string"
},
"companyName": {
"type": "string"
}
}
},
"The HSM action property details.": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the HSM action property."
},
"value": {
"type": "string",
"description": "The value of the HSM action property."
},
"name": {
"type": "string",
"description": "The name of the HSM action property."
}
}
},
"The representation of the SearchChecklistInstanceSubSearch domain object. Note that this object works with the composition context of a Search dto.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of the search checklist instance subsearch.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication of the intent to delete the checklist instance subsearch."
},
"name": {
"type": "string",
"description": "The name of the search checklist instance subsearch."
},
"searchChecklistParameters": {
"items": {
"$ref": "#/definitions/The representation of the SearchChecklistParameter domain object. Note that this object works with the composition context of a Search dto."
},
"type": "array",
"description": "The parameters associated to the search checklist instance subsearch."
},
"required": {
"default": false,
"type": "boolean",
"description": "The flag indicating that results are required of this search checklist instance subsearch."
},
"searchCheckListInstanceId": {
"type": "string",
"description": "The unique indicator of the search checklist instance to which the subsearch is associated."
},
"id": {
"type": "string",
"description": "The unique identifier of the search checklist instance subsearch."
}
}
},
"The DTO object for a business day.": {
"type": "object",
"properties": {
"endTime": {
"type": "string",
"description": "Gets the end time of the business day."
},
"enabled": {
"default": false,
"type": "boolean",
"description": "Returns true if this business day is enabled."
},
"id": {
"type": "string",
"description": "Gets the id of the business day."
},
"startTime": {
"type": "string",
"description": "Gets the start time of the business day."
},
"weekDay": {
"type": "string",
"description": "Gets the weekday of the business day."
}
}
},
"RenderedChart": {
"type": "object"
},
"FormControlValidator": {
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean"
},
"validator": {
"$ref": "#/definitions/Validator"
},
"formControlStep": {
"$ref": "#/definitions/FormControlStep"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"Object that represents a document overlay.": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the overlay."
},
"tempFileId": {
"type": "string",
"description": "The ID/extension of the temporary file where the overlay file is stored, if the file is being added or updated."
},
"overlayId": {
"type": "string",
"description": "ID of the overlay."
},
"path": {
"type": "string",
"description": "Path to the overlay."
},
"id": {
"type": "string",
"description": "ID of the overlay."
},
"name": {
"type": "string",
"description": "Name of the overlay."
}
}
},
"A column definition for a table chart.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The column ordinal.",
"format": "int32"
},
"chartDataGridId": {
"type": "string",
"description": "The ID of the table chart that owns this column."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this column should be deleted."
},
"sourceType": {
"enum": [
"DATASOURCE",
"DASHBOARD_INPUT",
"DERIVED_VALUE"
],
"type": "string",
"description": "The source data type for the column. I don't think this is used anymore."
},
"sortOrdinal": {
"type": "integer",
"description": "The column sort ordinal.",
"format": "int32"
},
"gridSummaryRowType": {
"enum": [
"NONE",
"SUM",
"COUNT"
],
"type": "string",
"description": "The type of summary data for the column."
},
"headerText": {
"type": "string",
"description": "The column header text."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The column data type."
},
"sortDirection": {
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "The column sort direction."
},
"dataField": {
"type": "string",
"description": "The column data field."
},
"hidden": {
"default": false,
"type": "boolean",
"description": "Whether the column is hidden."
},
"id": {
"type": "string",
"description": "The ID of the column."
}
}
},
"An instance of a chart on a dashboard at the top level.": {
"required": [
"chartableId"
],
"type": "object",
"properties": {
"drillDowns": {
"items": {
"$ref": "#/definitions/A transition from a chart to another object: a chart, dashboard, or URL."
},
"type": "array",
"description": "The drill downs configured for this DashboardChartable."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"layout": {
"description": "The layout of this item.",
"$ref": "#/definitions/An object that defines the layout of a chart on a dashboard."
},
"drillDownCount": {
"type": "integer",
"description": "The number of drill downs used in this DashboardChartable.",
"format": "int64"
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this DashboardChartable."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether this item is in a valid state."
},
"chartableName": {
"type": "string",
"description": "The name of the chart."
},
"chartableId": {
"type": "string",
"description": "The ID of the chart."
},
"chartableType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this DashboardChartable."
},
"input": {
"items": {
"$ref": "#/definitions/An input to a chart on a dashboard."
},
"type": "array",
"description": "The inputs to the DashboardChartable."
},
"id": {
"type": "string",
"description": "The ID of the DashboardChartable."
},
"chartableIsValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
}
}
},
"A gauge chart.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"FormActionProperty": {
"required": [
"formAction",
"propertyName",
"propertyValue"
],
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean"
},
"propertyName": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyValue": {
"type": "string"
},
"formAction": {
"$ref": "#/definitions/FormAction"
},
"id": {
"type": "string"
}
}
},
"FormControlValidatorDTO": {
"type": "object",
"properties": {
"validatorName": {
"type": "string"
},
"formControlStepId": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"validator": {
"$ref": "#/definitions/An object representing a validator."
},
"formControlStepName": {
"type": "string"
},
"validatorId": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"SearchDocIndexing": {
"required": [
"allowDocCreation",
"search"
],
"type": "object",
"properties": {
"allowDocCreation": {
"default": false,
"type": "boolean"
},
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"searchDocIndexingMetadata": {
"items": {
"$ref": "#/definitions/SearchDocIndexingMetadata"
},
"type": "array"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"id": {
"type": "string"
}
}
},
"FileStore": {
"required": [
"rotation"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"creator": {
"type": "string"
},
"shared": {
"default": false,
"type": "boolean"
},
"relativePath": {
"type": "string"
},
"pageCount": {
"type": "integer",
"format": "int64"
},
"redacted": {
"default": false,
"type": "boolean"
},
"externalFileStoreProps": {
"items": {
"$ref": "#/definitions/ExternalFileStoreProp"
},
"type": "array"
},
"fileDefinitionType": {
"enum": [
"IN_PLACE",
"POINTER",
"STANDARD",
"FORM",
"EXTERNAL",
"CHECKLIST"
],
"type": "string"
},
"importDate": {
"type": "string",
"format": "date-time"
},
"inRepository": {
"default": false,
"type": "boolean"
},
"printable": {
"default": false,
"type": "boolean"
},
"external": {
"default": false,
"type": "boolean"
},
"checksum": {
"type": "string"
},
"path": {
"type": "string"
},
"rotation": {
"type": "integer",
"format": "int32"
},
"scaleToFlex": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
}
}
},
"A parent class for all Kendo charts.": {
"allOf": [
{
"$ref": "#/definitions/The representation of a Chart object."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"Form": {
"required": [
"dateModified",
"height",
"isLocked",
"name",
"status",
"version",
"width"
],
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"INACTIVE_STILL_RUNNING",
"DELETED"
],
"type": "string"
},
"styles": {
"type": "string"
},
"allowAnonymousAccessToView": {
"default": false,
"type": "boolean"
},
"formControls": {
"items": {
"$ref": "#/definitions/FormControl"
},
"type": "array"
},
"description": {
"type": "string"
},
"allowAnonymousAccessToEdit": {
"default": false,
"type": "boolean"
},
"currentStep": {
"$ref": "#/definitions/FormStep"
},
"name": {
"type": "string"
},
"height": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"isLocked": {
"default": false,
"type": "boolean"
},
"version": {
"type": "integer",
"format": "int32"
},
"steps": {
"items": {
"$ref": "#/definitions/FormStep"
},
"type": "array"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"dateModified": {
"type": "string",
"format": "date-time"
},
"formInstances": {
"items": {
"$ref": "#/definitions/FormInstance"
},
"type": "array"
},
"id": {
"type": "string"
},
"lockOwner": {
"type": "string"
}
}
},
"The definition of a data source.": {
"type": "object",
"properties": {
"parameterNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "The parameter names of the datasource."
},
"intents": {
"items": {
"$ref": "#/definitions/The intent of a data source."
},
"type": "array",
"description": "The datasource intents of the datasource."
},
"referenced": {
"default": false,
"type": "boolean",
"description": "The referenced attribute of the datasource."
},
"displayName": {
"type": "string",
"description": "The display name of the datasource."
},
"description": {
"type": "string",
"description": "The description of the datasource."
},
"parameters": {
"items": {
"$ref": "#/definitions/The definition of a data source parameters."
},
"type": "array",
"description": "The datasource parameter of the datasource."
},
"datasourceType": {
"type": "string",
"description": "The type of the datasource."
},
"configResourcePath": {
"type": "string",
"description": "The config resource path of the datasource."
},
"isEditable": {
"default": false,
"type": "boolean",
"description": "Whether the datasource is editable."
},
"properties": {
"items": {
"$ref": "#/definitions/The definition of a data source properties."
},
"type": "array",
"description": "The datasource properties associated with the datasource."
},
"clientOnly": {
"default": false,
"type": "boolean",
"description": "Whether the datasource is cient only."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The marked for delete attribute of the datasource."
},
"hasCustomInterface": {
"default": false,
"type": "boolean",
"description": "If true the datasource type has its own custom interface."
},
"testable": {
"default": false,
"type": "boolean",
"description": "If true the datasource can be tested."
},
"promptList": {
"items": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": "array",
"description": "The parameter prompt associated with the datasource."
},
"id": {
"type": "string",
"description": "The id of the datasource."
},
"entryControlResourcePath": {
"type": "string",
"description": "The entry control resource flag of the datasource."
},
"name": {
"type": "string",
"description": "The name of the datasource."
}
}
},
"GrantedAuthority": {
"type": "object",
"properties": {
"authority": {
"type": "string"
}
}
},
"ServiceInfoDTO": {
"type": "object",
"properties": {
"operations": {
"items": {
"$ref": "#/definitions/OperationInfoDTO"
},
"type": "array"
},
"name": {
"type": "string"
}
}
},
"A static hidden integer input.": {
"allOf": [
{
"$ref": "#/definitions/A static hidden input to a dashboard."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"staticType": {
"enum": [
"BOOLEAN",
"DATE",
"DECIMAL",
"INTEGER",
"STRING"
],
"type": "string",
"description": "The type of static input."
},
"value": {
"type": "object"
},
"integerValue": {
"type": "integer",
"description": "The static integer value.",
"format": "int32"
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"A static hidden decimal input.": {
"allOf": [
{
"$ref": "#/definitions/A static hidden input to a dashboard."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"staticType": {
"enum": [
"BOOLEAN",
"DATE",
"DECIMAL",
"INTEGER",
"STRING"
],
"type": "string",
"description": "The type of static input."
},
"decimalValue": {
"type": "number",
"description": "The static decimal value.",
"format": "double"
},
"value": {
"type": "object"
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"Represents a document that is currently being edited.": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the user who is editing the document."
},
"cancelDate": {
"type": "string",
"description": "The date/time this edit was cancelled.",
"format": "date-time"
},
"shared": {
"default": false,
"type": "boolean",
"description": "Whether any pages of the edited document come from a shared (pointer) document."
},
"sourceType": {
"enum": [
"EDIT_LOCK",
"SEARCH_RESULTS",
"BATCH",
"BPM"
],
"type": "string",
"description": "The source of this edit lock."
},
"firstName": {
"type": "string",
"description": "The first name of the user who is editing the document."
},
"canceledBy": {
"type": "string",
"description": "The username of the user who cancelled this edit."
},
"lastName": {
"type": "string",
"description": "The last name of the user who is editing the document."
},
"documentType": {
"type": "string",
"description": "The document type of the docuemnt."
},
"documentDisplayName": {
"type": "string",
"description": "The display name of the document."
},
"pages": {
"items": {
"$ref": "#/definitions/EditQueuePageDTO"
},
"type": "array",
"description": "The individual pages that make up the current state of the edited document."
},
"versioned": {
"default": false,
"type": "boolean",
"description": "Whether the edit lock is subject to versioning."
},
"editAction": {
"enum": [
"DOWNLOAD_TO_EDIT",
"EDIT_NATIVELY",
"EDIT_DOCUMENT",
"EDIT_CANCELLED",
"AUTO_REPLACE",
"COMMIT_PENDING",
"CANCEL_PENDING",
"UNSUPPORTED"
],
"type": "string",
"description": "The latest action for this edit lock."
},
"editToken": {
"type": "string",
"description": "The unique edit token for this edit lock."
},
"sourceTarget": {
"type": "string",
"description": "The ID of the source for the edit lock. For example, if sourceType is BATCH, this is the ID of the batch."
},
"documentCategory": {
"type": "string",
"description": "The Category of the document."
},
"editStartDate": {
"type": "string",
"description": "The date/time the document was initially edited.",
"format": "date-time"
},
"fileDefinitionType": {
"enum": [
"IN_PLACE",
"POINTER",
"STANDARD",
"FORM",
"EXTERNAL",
"CHECKLIST"
],
"type": "string",
"description": "The file type of the document."
},
"canDelete": {
"default": false,
"type": "boolean",
"description": "Whether this edited document can be deleted."
},
"id": {
"type": "string",
"description": "The ID of the edit lock."
},
"documentId": {
"type": "string",
"description": "The document ID of the document being edited. Note that this can be empty if this is a new document."
},
"editFileName": {
"type": "string",
"description": "The file name to use when downloading the edited file."
}
}
},
"Cold importer narrative test data results": {
"type": "object",
"properties": {
"endLine": {
"type": "integer",
"description": "The end line for the report",
"format": "int32"
},
"headers": {
"items": {
"type": "string"
},
"type": "array",
"description": "The headers"
},
"narrativeTestId": {
"type": "string",
"description": "The narrative test id"
},
"startLine": {
"type": "integer",
"description": "The start line for the report",
"format": "int32"
},
"lineCount": {
"type": "integer",
"description": "The total line count",
"format": "int64"
}
}
},
"An object representing a group assignment.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The markedForDelete flag."
},
"entityType": {
"enum": [
"BATCHES",
"DASHBOARDS",
"EXPORT_PROFILES",
"FAX",
"FORMS",
"JOB_VIEWS",
"PRINTER",
"PROCESS_MODELS",
"SEARCH",
"SECURITY_ACCESS",
"SCAN_PROFILES",
"USERS",
"FEATURE_RIGHTS"
],
"type": "string",
"description": "The type of entity."
},
"entityIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "The entity IDs."
},
"groups": {
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array",
"description": "The groups."
}
}
},
"RepositoryStorageOptionDTO": {
"type": "object",
"properties": {
"storageType": {
"enum": [
"LEVEL_ONE",
"LEVEL_TWO",
"LEVEL_THREE"
],
"type": "string"
}
}
},
"The process instance configuration associated with the rule set.": {
"type": "object",
"properties": {
"calculatedProperty": {
"type": "string",
"description": "The calculated property which is associated with the process instance variable configuration in the rule set."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag to indicate the rule set process instance variable is to be deleted."
},
"valueType": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"VARIABLE",
"MIXED"
],
"type": "string",
"description": "The type of value for the calculated property."
},
"id": {
"type": "string",
"description": "The id of the process instance configuration associated with the rule set."
},
"ruleSetId": {
"type": "string",
"description": "The id of the rule set."
},
"variableName": {
"type": "string",
"description": "The variable name of the process instance variable associated with the rule set."
},
"defaultValue": {
"type": "string",
"description": "The default value."
}
}
},
"ParameterPromptDatasourceArgDTO": {
"type": "object",
"properties": {
"datasourceArgumentName": {
"type": "string"
},
"value": {
"type": "string"
},
"argumentType": {
"enum": [
"NONE",
"STATIC",
"MACRO",
"PROMPT"
],
"type": "string"
}
}
},
"PackageItemDTO": {
"type": "object",
"properties": {
"packageItemName": {
"type": "string"
},
"type": {
"type": "string"
},
"properties": {
"items": {
"$ref": "#/definitions/Configuration informaton to send a value through webservices."
},
"type": "array"
}
}
},
"DocumentTypeMetadataIndexing": {
"type": "object",
"properties": {
"sort": {
"default": false,
"type": "boolean"
},
"setFocus": {
"default": false,
"type": "boolean"
},
"blindEntry": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"retainValue": {
"default": false,
"type": "boolean"
},
"allowErrorOverride": {
"default": false,
"type": "boolean"
},
"documentTypeMetadataDescriptor": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"characterCase": {
"enum": [
"NORMAL",
"UPPER",
"LOWER"
],
"type": "string"
},
"id": {
"type": "string"
}
}
},
"User": {
"required": [
"emailAddress",
"firstName",
"lastName",
"middleName",
"userStatus",
"userType",
"username"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"credentialsNonExpired": {
"default": false,
"type": "boolean"
},
"userType": {
"enum": [
"INTERNAL",
"EXTERNAL",
"SYSTEM"
],
"type": "string"
},
"attempts": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"authorities": {
"items": {
"$ref": "#/definitions/GrantedAuthority"
},
"type": "array"
},
"associationLevel": {
"enum": [
"ALL",
"PARTIAL",
"NONE"
],
"type": "string"
},
"id": {
"type": "string"
},
"memberships": {
"items": {
"$ref": "#/definitions/GroupMember"
},
"type": "array"
},
"middleName": {
"type": "string"
},
"oldUserStatus": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string"
},
"userStatus": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"userViewerSettings": {
"items": {
"$ref": "#/definitions/UserViewerSetting"
},
"type": "array"
},
"username": {
"type": "string"
},
"externallyManaged": {
"default": false,
"type": "boolean"
},
"formInstances": {
"items": {
"$ref": "#/definitions/FormInstance"
},
"type": "array"
},
"emailAddress": {
"type": "string"
},
"groups": {
"items": {
"$ref": "#/definitions/Group"
},
"type": "array"
},
"oldUsername": {
"type": "string"
},
"lastInvalidAttempt": {
"type": "string",
"format": "date-time"
},
"password": {
"type": "string"
},
"retentionPolicyCustodians": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/RetentionPolicyCustodian"
},
"type": "array"
},
"accountNonLocked": {
"default": false,
"type": "boolean"
},
"accountNonExpired": {
"default": false,
"type": "boolean"
},
"firstName": {
"type": "string"
},
"roleActors": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/Actor"
},
"type": "array"
},
"lastName": {
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"systemMessagePreference": {
"items": {
"$ref": "#/definitions/SystemMessageUserPreference"
},
"type": "array"
},
"legalHoldCustodians": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/LegalHoldCustodian"
},
"type": "array"
}
}
},
"Auditing data used to configure auditing levels for the system.": {
"required": [
"auditCategoryType",
"auditType",
"description",
"enabled",
"includedInDocInfo",
"includedInRecordInfo"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The localized description of the audit type."
},
"enabled": {
"default": false,
"type": "boolean",
"description": "The boolean flag indicating if the auditing event type is configured to record an audit or not."
},
"includedInDocInfo": {
"default": false,
"type": "boolean",
"description": "The boolean indication whether or not the audit type is used in DocumentHistory functionality."
},
"includedInRecordInfo": {
"default": false,
"type": "boolean",
"description": "The boolean indication whether or not the audit type is used in Records Search functionality."
},
"auditCategoryType": {
"enum": [
"ADMINISTRATION",
"ALERTS",
"AUTHENTICATION",
"BATCH_ACTIONS",
"BPM_ACTIONS",
"DASHBOARDS",
"DOCUMENT_ACTIONS",
"DOCUMENT_CHANGES",
"DOCUMENT_VIEWING",
"EMAIL",
"EXPORT",
"EFORMS",
"HSM",
"LICENSE",
"RECORDS_MANAGEMENT",
"SEARCH_ACTIONS",
"SECURITY_CHANGE"
],
"type": "string",
"description": "The auditing category, used for organizational purposes."
},
"auditType": {
"enum": [
"AUTHENTICATE_SUCCESS",
"AUTHENTICATE_FAIL",
"AUTHENTICATE_EXPIRE",
"BATCH_COMMIT",
"BATCH_CREATE",
"BATCH_UPDATE",
"BATCH_DELETE",
"BATCH_CHECK_IN",
"BATCH_CHECK_OUT",
"BATCH_DOCUMENT_CREATE",
"BATCH_DOCUMENT_DELETE",
"BATCH_GROUP_ACCESS_CREATE",
"BATCH_GROUP_ACCESS_DELETE",
"BPM_ABSENCE_CREATE",
"BPM_ABSENCE_DELETE",
"BPM_BUSINESS_HOURS_CREATE",
"BPM_BUSINESS_HOURS_UPDATE",
"BPM_BUSINESS_HOURS_DELETE",
"BPM_DOCUMENT_TYPE_PROCESS_MODEL_CREATE",
"BPM_DOCUMENT_TYPE_PROCESS_MODEL_UPDATE",
"BPM_DOCUMENT_TYPE_PROCESS_MODEL_DELETE",
"BPM_HOLIDAY_CREATE",
"BPM_HOLIDAY_UPDATE",
"BPM_HOLIDAY_DELETE",
"BPM_JOB_CREATE",
"BPM_JOB_READ",
"BPM_JOB_UPDATE",
"BPM_JOB_DELETE",
"BPM_JOB_CHECK_OUT",
"BPM_JOB_RELEASE",
"BPM_JOB_RETURN",
"BPM_JOB_REDISTRIBUTE",
"BPM_JOB_MOVE",
"BPM_JOB_SET_DUE_DATE",
"BPM_JOB_COMPLETE",
"BPM_JOB_DISTRIBUTE",
"BPM_JOB_ACTOR_UPDATE",
"BPM_LIBRARY_ENTITY_CREATE",
"BPM_LIBRARY_ENTITY_DELETE",
"BPM_SUBPROCESS_CREATE",
"BPM_PROCESS_CREATE",
"BPM_PROCESS_DELETE",
"BPM_PROCESS_CLEAN",
"BPM_PROCESS_START",
"BPM_PROCESS_ADD_PACKAGE_ITEM",
"BPM_PROCESS_END",
"BPM_PROCESS_STEP_FORWARD",
"BPM_COMPLETE_NODE",
"BPM_PROCESS_MIGRATE",
"BPM_PROCESS_MODEL_UPDATE",
"BPM_PROCESS_MODEL_DELETE",
"BPM_PROCESS_MODEL_EXPORT",
"BPM_PROCESS_MODEL_IMPORT",
"BPM_PROCESS_MODEL_ACTIVATE",
"BPM_PROCESS_MODEL_DEACTIVATE",
"BPM_PROCESS_MODEL_CHECK_IN",
"BPM_PROCESS_MODEL_CHECK_OUT",
"BPM_PROCESS_MODEL_UNLOCK",
"BPM_PROCESS_MODEL_GROUP_ADD",
"BPM_PROCESS_MODEL_GROUP_DELETE",
"BPM_NODE_ENTER",
"BPM_NODE_LEAVE",
"BPM_QUEUE_MOVE_TO_PERSONAL",
"BPM_ROLE_CREATE",
"BPM_ROLE_UPDATE",
"BPM_ROLE_DELETE",
"BPM_SHIFT_CREATE",
"BPM_SHIFT_UPDATE",
"BPM_SHIFT_DELETE",
"BPM_TASK_COMPLETE",
"BPM_TASK_INCOMPLETE",
"BPM_SERVICE_TASK_COMPLETE",
"BPM_SERVICE_TASK_FAILED",
"BPM_VIEW_CREATE",
"BPM_VIEW_UPDATE",
"BPM_VIEW_DELETE",
"CALCULATED_PROPERTY_CREATE",
"CALCULATED_PROPERTY_UPDATE",
"CALCULATED_PROPERTY_DELETE",
"CALCULATED_PROPERTY_DATASOURCE_PARAMETER_CREATE",
"CALCULATED_PROPERTY_DATASOURCE_PARAMETER_UPDATE",
"CALCULATED_PROPERTY_DATASOURCE_PARAMETER_DELETE",
"CHART_CREATE",
"CHART_UPDATE",
"CHART_DELETE",
"CHART_OVERWRITE",
"CHART_IMPORT",
"CHART_EXPORT",
"CHART_DATA_GRID_CREATE",
"CHART_DATA_GRID_UPDATE",
"CHART_DATA_GRID_DELETE",
"CHART_TEXT_CREATE",
"CHART_TEXT_UPDATE",
"CHART_TEXT_DELETE",
"CHECKLIST_UPDATE",
"CHECKLIST_DELETE",
"CHECKLIST_DYNAMIC_SUBSEARCH_CREATE",
"CHECKLIST_DYNAMIC_SUBSEARCH_DELETE",
"CHECKLIST_DYNAMIC_SUBSEARCH_UPDATE",
"CHECKLIST_SUBSEARCH_CREATE",
"CHECKLIST_SUBSEARCH_DELETE",
"CHECKLIST_SUBSEARCH_UPDATE",
"CHECKLIST_DYNAMIC_PARAMETER_CREATE",
"CHECKLIST_DYNAMIC_PARAMETER_DELETE",
"CHECKLIST_DYNAMIC_PARAMETER_UPDATE",
"CHECKLIST_SUBSEARCH_PARAMETER_CREATE",
"CHECKLIST_SUBSEARCH_PARAMETER_DELETE",
"CHECKLIST_SUBSEARCH_PARAMETER_UPDATE",
"SEARCH_DOC_INDEXING_CREATE",
"SEARCH_DOC_INDEXING_DELETE",
"SEARCH_DOC_INDEXING_UPDATE",
"SEARCH_DOC_INDEXING_METADATA_CREATE",
"SEARCH_DOC_INDEXING_METADATA_DELETE",
"SEARCH_DOC_INDEXING_METADATA_UPDATE",
"DASHBOARD_CATEGORY_CREATE",
"DASHBOARD_CATEGORY_UPDATE",
"DASHBOARD_CATEGORY_DELETE",
"DASHBOARD_CREATE",
"DASHBOARD_DELETE",
"DASHBOARD_UPDATE",
"DASHBOARD_OVERWRITE",
"DASHBOARD_CHECK_IN",
"DASHBOARD_CHECK_OUT",
"CHART_CHECK_IN",
"CHART_CHECK_OUT",
"DASHBOARD_GROUP_ADD",
"DASHBOARD_GROUP_DELETE",
"DASHBOARD_IMPORT",
"DASHBOARD_EXPORT",
"DATA_STORE_CREATE",
"DATA_STORE_UPDATE",
"DATA_STORE_DELETE",
"DATABASE_CONNECTION_CREATE",
"DATABASE_CONNECTION_UPDATE",
"DATABASE_CONNECTION_DELETE",
"DATASOURCE_CREATE",
"DATASOURCE_UPDATE",
"DATASOURCE_DELETE",
"DIARY_ENTRY_CREATE",
"DOCUMENT_UPDATE",
"DOCUMENT_UPLOAD",
"DOCUMENT_CREATE",
"DOCUMENT_CREATE_PRINT_TO",
"DOCUMENT_CREATE_SEND_TO",
"DOCUMENT_CREATE_SCAN_TO",
"DOCUMENT_CREATE_IMPORT",
"DOCUMENT_CREATE_SCAN",
"DOCUMENT_CREATE_BPM",
"DOCUMENT_CREATE_FILE_UPLOAD",
"DOCUMENT_CREATE_OFFICE",
"DOCUMENT_CREATE_FORM",
"DOCUMENT_CREATE_POINTER",
"POINTER_CREATE",
"DOCUMENT_CREATE_SAVE_SEARCH",
"DOCUMENT_CREATE_EDITING",
"CHECKLIST_CREATE",
"CLIPBOARD_ITEM_ADD",
"DOCUMENT_DELETE",
"DOCUMENT_PURGE",
"DOCUMENT_MOVE",
"DOCUMENT_PARTIAL_PURGE",
"DOCUMENT_RESTORE",
"DOCUMENT_VIEW",
"DOCUMENT_THUMBNAIL_VIEW",
"DOCUMENT_DOWNLOAD",
"DOCUMENT_FILE_REPLACE",
"DOCUMENT_CATEGORY_CREATE",
"DOCUMENT_CATEGORY_UPDATE",
"DOCUMENT_CATEGORY_DELETE",
"DOCUMENT_SECURITY_CREATE",
"DOCUMENT_SECURITY_UPDATE",
"DOCUMENT_SECURITY_DELETE",
"DOCUMENT_TYPE_CREATE",
"DOCUMENT_TYPE_UPDATE",
"DOCUMENT_TYPE_DELETE",
"DOCUMENT_TYPE_GROUP_CREATE",
"DOCUMENT_TYPE_GROUP_UPDATE",
"DOCUMENT_TYPE_GROUP_DELETE",
"DOCUMENT_TYPE_METADATA_ASSIGN",
"DOCUMENT_TYPE_METADATA_REMOVE",
"DOCUMENT_TYPE_OVERLAY_CREATE",
"DOCUMENT_TYPE_OVERLAY_DELETE",
"DOCUMENT_TYPE_SCAN_SETTING_CREATE",
"DOCUMENT_TYPE_SCAN_SETTING_UPDATE",
"DOCUMENT_TYPE_SCAN_SETTING_DELETE",
"EDITING_CHECKOUT_DOCUMENT",
"EDITING_ADMIN_CANCEL_EDIT",
"EDITING_CANCEL_EDIT",
"EDITING_CHECKIN_DOCUMENT",
"EDITING_COMMIT_DOCUMENT",
"EDITING_PAGE_ADDED",
"EMAIL_SENT",
"EMAIL_SENT_OUTLOOK",
"FAX_TAKE_FAX_SERVICES_OFFLINE",
"FAX_BRING_FAX_SERVICES_ONLINE",
"FAX_FAX_SERVICE_GROUPS_ADD",
"FAX_FAX_SERVICE_GROUPS_DELETE",
"FORM_DESIGN_CREATE",
"FORM_DESIGN_UPDATE",
"FORM_DESIGN_DELETE",
"FORM_DESIGN_IMPORT",
"FORM_DESIGN_EXPORT",
"FORM_DESIGN_ACTIVATE",
"FORM_DESIGN_DEACTIVATE",
"FORM_DESIGN_CHECK_IN",
"FORM_DESIGN_CHECK_OUT",
"FORM_DESIGN_OVERWRITE",
"FORM_INSTANCE_ADD",
"FORM_INSTANCE_UPDATE",
"FORM_INSTANCE_DELETE",
"FORM_INSTANCE_SUBMIT",
"FORM_INSTANCE_CHECK_IN",
"FORM_INSTANCE_CHECK_OUT",
"FORM_INSTANCE_UNLOCK",
"FORM_GROUP_ADD",
"FORM_GROUP_DELETE",
"GROUP_DELETE",
"GROUP_FEATURE_RIGHT_CREATE",
"GROUP_FEATURE_RIGHT_DELETE",
"HOTKEY_RESET",
"HOTKEY_UPDATE",
"IMPORTER_CONFIGURATION_EXPORT",
"IMPORTER_CREATE",
"IMPORTER_UPDATE",
"IMPORTER_DELETE",
"IMPORTER_SCHEDULE_ENABLED",
"IMPORTER_SCHEDULE_DISABLED",
"IMPORTER_START",
"IMPORTER_STOP",
"INDEXING_CREATE",
"INDEXING_UPDATE",
"INDEXING_CONFIG_UPDATE",
"INDEXING_CONFIG_DELETE",
"LDAP_SYNC_START",
"LDAP_SYNC_END",
"LDAP_SYNC",
"LDAP_SYNC_SCHEDULE_ENABLED",
"LDAP_SYNC_SCHEDULE_DISABLED",
"LDAP_CONFIGURED",
"LDAP_DELETED",
"LEGAL_HOLD_CREATE",
"LEGAL_HOLD_RELEASE",
"LEGAL_HOLD_CASE_CREATE",
"LEGAL_HOLD_CASE_DELETE",
"LEGAL_HOLD_CASE_UPDATE",
"LEGAL_HOLD_CASE_CLOSE",
"LEGAL_HOLD_CASE_REMOVE_ALL_HOLDS",
"LEGAL_HOLD_CUSTODIAN_CREATE",
"LEGAL_HOLD_CUSTODIAN_DELETE",
"LICENSE_DEDICATED_CREATE",
"LICENSE_DEDICATED_DELETE",
"LICENSE_EMAIL_CONFIGURED",
"LICENSE_POOL_GROUP_CREATE",
"LICENSE_POOL_GROUP_UPDATE",
"LICENSE_POOL_GROUP_DELETE",
"LICENSE_FILE_UPLOAD",
"LICENSE_REVOKED",
"LICENSE_DENIED",
"LOGOUT_SUCCESS",
"METADATA_CREATE",
"METADATA_UPDATE",
"METADATA_DELETE",
"METADATA_VALUE_CREATE",
"METADATA_VALUE_UPDATE",
"METADATA_VALUE_DELETE",
"MARKUP_CREATE",
"MARKUP_UPDATE",
"MARKUP_DELETE",
"STAMP_TEXT_CREATE",
"STAMP_TEXT_DELETE",
"STAMP_TEXT_UPDATE",
"OVERLAY_CREATE",
"OVERLAY_UPDATE",
"OVERLAY_UPLOAD",
"OVERLAY_DELETE",
"PRINTFAX_ENQUEUE_PRINT_JOB",
"PRINTFAX_ENQUEUE_FAX_JOB",
"PRINTFAX_CANCEL_JOB",
"PRINTFAX_DEVICES_CREATE",
"PRINTFAX_DEVICES_UPDATE",
"PRINTFAX_DEVICES_DELETE",
"PRINTFAX_SERVERS_CREATE",
"PRINTFAX_SERVERS_UPDATE",
"PRINTFAX_SERVERS_DELETE",
"PRINTFAX_TAKE_DEVICES_OFFLINE",
"PRINTFAX_BRING_DEVICES_ONLINE",
"PRINTFAX_DEVICE_GROUPS_CREATE",
"PRINTFAX_DEVICE_GROUPS_DELETE",
"PRINTFAX_FAX_SERVICES_CREATE",
"PRINTFAX_FAX_SERVICES_UPDATE",
"PRINTFAX_FAX_SERVICES_DELETE",
"PROPERTY_CREATE",
"PROPERTY_UPDATE",
"PROPERTY_DELETE",
"SCAN_SETTING_CREATE",
"SCAN_SETTING_UPDATE",
"SCAN_SETTING_DELETE",
"SCAN_SETTING_GROUP_CREATE",
"SCAN_SETTING_GROUP_UPDATE",
"SCAN_SETTING_GROUP_DELETE",
"SCHEDULE_CREATE",
"SCHEDULE_DELETE",
"REPOSITORY_CREATE",
"REPOSITORY_DELETE",
"REPOSITORY_UPDATE",
"REPORT_IMPORTER_HEADER_LINE_PROPERTY_CREATE",
"REPORT_IMPORTER_HEADER_LINE_PROPERTY_UPDATE",
"REPORT_IMPORTER_HEADER_LINE_PROPERTY_DELETE",
"REPORT_IMPORTER_SORT_COLUMN_CREATE",
"REPORT_IMPORTER_SORT_COLUMN_UPDATE",
"REPORT_IMPORTER_SORT_COLUMN_DELETE",
"REPORT_IMPORTER_MERGE_FIELD_CREATE",
"REPORT_IMPORTER_MERGE_FIELD_UPDATE",
"REPORT_IMPORTER_MERGE_FIELD_DELETE",
"REPORT_IMPORTER_COMPARE_FIELD_CREATE",
"REPORT_IMPORTER_COMPARE_FIELD_UPDATE",
"REPORT_IMPORTER_COMPARE_FIELD_DELETE",
"RULE_SET_CREATE",
"RULE_SET_UPDATE",
"RULE_SET_DELETE",
"RULE_SET_ASSIGNMENT_CREATE",
"RULE_SET_ASSIGNMENT_UPDATE",
"RULE_SET_ASSIGNMENT_DELETE",
"RULE_SET_CONDITION_CREATE",
"RULE_SET_CONDITION_UPDATE",
"RULE_SET_CONDITION_DELETE",
"RULE_SET_BATCH_GROUP_CREATE",
"RULE_SET_BATCH_GROUP_UPDATE",
"RULE_SET_BATCH_GROUP_DELETE",
"RULE_SET_PROCESS_INSTANCE_VARIABLE_CREATE",
"RULE_SET_PROCESS_INSTANCE_VARIABLE_UPDATE",
"RULE_SET_PROCESS_INSTANCE_VARIABLE_DELETE",
"SEARCH_CREATE",
"SEARCH_UPDATE",
"SEARCH_DELETE",
"SEARCH_GROUP_CREATE",
"SEARCH_GROUP_UPDATE",
"SEARCH_GROUP_DELETE",
"SEARCH_CATEGORY_CREATE",
"SEARCH_CATEGORY_UPDATE",
"SEARCH_CATEGORY_DELETE",
"SEARCH_DOCUMENT_TYPE_CREATE",
"SEARCH_DOCUMENT_TYPE_UPDATE",
"SEARCH_DOCUMENT_TYPE_DELETE",
"SEARCH_FORM_DATA_CREATE",
"SEARCH_FORM_DATA_DELETE",
"SEARCH_FORM_DATA_UPDATE",
"SEARCH_TREE_FILTER_CREATE",
"SEARCH_TREE_FILTER_DELETE",
"SEARCH_TREE_FILTER_UPDATE",
"SEARCH_PARAMETER_CREATE",
"SEARCH_PARAMETER_UPDATE",
"SEARCH_PARAMETER_DELETE",
"SEARCH_PROMPT_CREATE",
"SEARCH_PROMPT_UPDATE",
"SEARCH_PROMPT_DELETE",
"SEARCH_PROMPT_VALUES_CREATE",
"SEARCH_PROMPT_VALUES_UPDATE",
"SEARCH_PROMPT_VALUES_DELETE",
"SEARCH_RESULT_CREATE",
"SEARCH_RESULT_UPDATE",
"SEARCH_RESULT_DELETE",
"SEARCH_RESULT_LINKED_METADATA_CREATE",
"SEARCH_RESULT_LINKED_METADATA_UPDATE",
"SEARCH_RESULT_LINKED_METADATA_DELETE",
"SEARCH_SORT_ORDER_CREATE",
"SEARCH_SORT_ORDER_UPDATE",
"SEARCH_SORT_ORDER_DELETE",
"SEARCH_SORT_ORDER_CUSTOM_CREATE",
"SEARCH_SORT_ORDER_CUSTOM_UPDATE",
"SEARCH_SORT_ORDER_CUSTOM_DELETE",
"SEARCH_EXECUTION_CATEGORY",
"SEARCH_EXECUTION_TREE",
"SEARCH_EXECUTION_TEMPLATE",
"SEARCH_EXECUTION_CHECKLIST",
"SEARCH_EXECUTION_STORED_PROCEDURE",
"SECURITY_FILTER_CREATE",
"SECURITY_FILTER_UPDATE",
"SECURITY_FILTER_DELETE",
"SERVER_CREATE",
"SERVER_UPDATE",
"SERVER_DELETE",
"SERVER_ALERT_CREATE",
"SERVER_ALERT_DELETE",
"SYSTEM_MESSAGE_DELETE",
"SYSTEM_MESSAGE_DELETE_ALL",
"SYSTEM_LOG_CLEAR",
"SYSTEM_SET_LOGLEVEL",
"SYSTEM_SET_LOGLEVEL_ALL",
"SYSTEM_PROPERTY_CREATE",
"SYSTEM_PROPERTY_UPDATE",
"USER_CREATE",
"USER_UPDATE",
"USER_DELETE",
"USER_FAVORITE_CREATE",
"USER_FAVORITE_UPDATE",
"USER_FAVORITE_DELETE",
"USER_GROUP_CREATE",
"USER_GROUP_UPDATE",
"USER_GROUP_MEMBER_CREATE",
"USER_GROUP_MEMBER_UPDATE",
"USER_GROUP_MEMBERSHIP_DELETE",
"USER_PASSWORD_UPDATE",
"USER_FORGOT_PASSWORD_UPDATE",
"USER_LOCKED_BY_INVALID_ATTEMPTS",
"VALIDATOR_CREATE",
"VALIDATOR_UPDATE",
"VALIDATOR_DELETE",
"XSD_CREATE",
"XSD_UPDATE",
"XSD_DELETE",
"WSDL_URL_CREATE",
"WSDL_URL_UPDATE",
"WSDL_URL_DELETE",
"HSM_CREATE",
"HSM_UPDATE",
"HSM_DELETE",
"HSM_START",
"HSM_STOP",
"HSM_SCHEDULE_ENABLED",
"HSM_SCHEDULE_DISABLED",
"HSM_ACTION_COPY",
"HSM_ACTION_MOVE",
"HSM_ACTION_PURGE",
"HSM_ACTION_START_PROCESS",
"HSM_ACTION_MOVE_AUDITS",
"HSM_ACTION_PURGE_COMPLETED_PROCESSES",
"HSM_ACTION_PURGE_FILES",
"HSM_RUN_ONCE",
"EXPORTER_PROFILE_CREATE",
"EXPORTER_PROFILE_DELETE",
"EXPORTER_PROFILE_UPDATE",
"EXPORTER_PROFILE_GROUP_CREATE",
"EXPORTER_PROFILE_GROUP_DELETE",
"EXPORTER_PROFILE_GROUP_UPDATE",
"EXPORTER_ENQUEUE_JOB",
"EXPORTER_PROCESS_JOB",
"EXPORTER_DELETE_JOB",
"EXPORTER_CANCEL_JOB",
"EXPORTER_DOWNLOAD",
"EXPORTER_SERVER_CREATE",
"EXPORTER_SERVER_UPDATE",
"EXPORTER_SERVER_DELETE",
"DOCUMENT_EXPORTED",
"SEARCH_RESULT_EXPORT_QUEUE",
"SEARCH_RESULT_EXPORT_DOWNLOAD",
"VERSION_INITIAL",
"VERSION_MAJOR",
"VERSION_MINOR",
"VERSION_REVERT",
"PASSWORD_RULE_UPDATE",
"RETENTION_POLICY_CREATE",
"RETENTION_POLICY_UPDATE",
"RETENTION_POLICY_DELETE",
"RETENTION_POLICY_CUSTODIAN_ADD",
"RETENTION_POLICY_CUSTODIAN_REMOVE",
"RETENTION_POLICY_DOCUMENT_TYPE_ASSIGN",
"RETENTION_POLICY_SCHEDULE_ENABLE",
"RETENTION_POLICY_DISPOSITION_EXECUTION",
"RETENTION_POLICY_OVERRIDE",
"RETENTION_POLICY_CANCEL_OVERRIDE",
"SERVER_STARTUP",
"SERVER_SHUTDOWN",
"AUDIT_SETTING_CHANGE",
"COLD_NARRATIVE_CREATE",
"COLD_NARRATIVE_UPDATE",
"COLD_NARRATIVE_DELETE"
],
"type": "string",
"description": "The auditing event type, recorded in the AuditMessages table as the audit."
},
"id": {
"type": "string",
"description": "The ID of the auditing configuration data."
}
}
},
"A paged search result for dashboards.": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"items": {
"$ref": "#/definitions/A dashboard used to display charts to a user."
},
"type": "array",
"description": "Representation of the pageable collection of dashboards."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"An object that provides the arguments needed to render a chart on a dashboard.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The drill down ordinal, starting at 0, used when rendering a drill down. Honestly I'm not sure why we aren't passing the ID of the drill down instead.",
"format": "int32"
},
"values": {
"description": "The values needed to render the chart, taken from dashboard inputs, chart output and parent chart input.",
"$ref": "#/definitions/An object that holds values needed to render a chart on a dashboard."
},
"dashboardChartableId": {
"type": "string",
"description": "The ID of the DashboardChartable to render."
}
}
},
"Category": {
"required": [
"description",
"name",
"status"
],
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentTypes": {
"items": {
"$ref": "#/definitions/DocumentType"
},
"type": "array"
},
"originalName": {
"type": "string"
},
"nameChanged": {
"default": false,
"type": "boolean"
},
"activeDocumentTypes": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentType"
},
"type": "array"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"A paged search result for group totals.": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"xml": {
"name": "result"
},
"items": {
"$ref": "#/definitions/An object representing a group containing the group id, group name and the number of active members in the group."
},
"type": "array",
"description": "A page of group total search results."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"SearchColumnValueDTO": {
"type": "object",
"properties": {
"columnType": {
"enum": [
"METADATA",
"LINKED_OUTPUT_COLUMN",
"CATEGORY",
"DOCUMENT_TYPE",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES"
],
"type": "string"
},
"attributeName": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Configuration data for assignments to be made during the import process.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "Ordinal of the rule set assignment object.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag indicating the rule set assignment object is to be deleted."
},
"assignmentType": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"VARIABLE",
"MIXED"
],
"type": "string",
"description": "The type of value for the assignment."
},
"assignment": {
"type": "string",
"description": "The value to assign to the metadata - either a macro, variable reference or static value."
},
"metadataId": {
"type": "string",
"description": "The metadata id to be assigned a value."
},
"metadataName": {
"type": "string",
"description": "The metadata name that must be assigned a value during the import process."
},
"ruleSetId": {
"type": "string",
"description": "The rule set id associated with the rule set assignment object."
},
"id": {
"type": "string",
"description": "The id of the rule set assignment."
}
}
},
"The representation of a subsearch for a particular search.": {
"type": "object",
"properties": {
"resultsRequired": {
"default": false,
"type": "boolean",
"description": "The indication as to whether or not results are required to be returned from this subsearch."
},
"results": {
"items": {
"$ref": "#/definitions/SearchResultRowDTO"
},
"type": "array",
"description": "The array of results returned by the subsearch."
},
"subSearchName": {
"type": "string",
"description": "The name of the subsearch."
}
}
},
"A paged search result for charts": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"items": {
"$ref": "#/definitions/The representation of a Chart object."
},
"type": "array",
"description": "The current page of charts."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"OperationInfoDTO": {
"type": "object",
"properties": {
"input": {
"items": {
"$ref": "#/definitions/ParameterDTO"
},
"type": "array"
},
"namespace": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"$ref": "#/definitions/ObjectDTO"
}
}
},
"The representation of a search.": {
"type": "object",
"properties": {
"searchGroups": {
"items": {
"$ref": "#/definitions/Representation of the search to group association."
},
"type": "array",
"description": "The array of groups associated to the search."
},
"searchParameters": {
"items": {
"$ref": "#/definitions/The representation of the parameter objects associated with a search."
},
"type": "array",
"description": "The array of parameters associated to the search."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication of the intent to delete the search."
},
"description": {
"type": "string",
"description": "The description of the search."
},
"searchChecklistInsSubSearches": {
"items": {
"$ref": "#/definitions/The representation of the SearchChecklistInstanceSubSearch domain object. Note that this object works with the composition context of a Search dto."
},
"type": "array",
"description": "The array of sub-searches of the checklist instance associated to the search."
},
"documentsExist": {
"default": false,
"type": "boolean",
"description": "The indication that a document associated to the search exists."
},
"searchResultColumns": {
"items": {
"$ref": "#/definitions/The representation of a search result column."
},
"type": "array",
"description": "The array of columns representing the results of the search."
},
"searchType": {
"enum": [
"TEMPLATE",
"CATEGORY",
"CHECKLIST",
"STORED_PROCEDURE",
"HSM"
],
"type": "string",
"description": "The type of the search."
},
"searchDocIndexing": {
"description": "The representation of the indexing configuration to associated to this search in the instance that a document can be generated.",
"$ref": "#/definitions/The representation of the document indexing configuration of a search."
},
"searchFormData": {
"items": {
"$ref": "#/definitions/The representation of the form data to associated to the search."
},
"type": "array",
"description": "The array of form data associated to the search."
},
"searchSubSearches": {
"items": {
"$ref": "#/definitions/The representation of the SearchChecklistSubSearch domain object. Note that this object works with the composition context of a Search dto. Sub searches are used within searches of type CHECKLIST. Each sub search can be seen as the logic portion of a search, determining which documents are returned. A checklist search is comprised of multiple sub searches, each of which is 'met' when it returns one or more documents that match its' parameters, or criteria."
},
"type": "array",
"description": "The array of checklist sub-searches associated to the search."
},
"searchPrompts": {
"items": {
"$ref": "#/definitions/The representation the SearchPrompt domain object. Note that this object works with the composition context of a Search DTO. The SearchPrompt DTO contains all that data necessary to setup a search prompt in the system."
},
"type": "array",
"description": "The array of prompts associated to the search."
},
"searchStoredProcedure": {
"description": "The stored procedure associated to the search.",
"$ref": "#/definitions/The representation of the stored procedure associated with the search."
},
"formEditable": {
"default": false,
"type": "boolean",
"description": "The indication that the associated form of the search can be edited."
},
"formDesignName": {
"type": "string",
"description": "The name of the form associated to the search."
},
"treeFiltersConfigured": {
"default": false,
"type": "boolean",
"description": "The indication that a tree is configured for the search."
},
"searchSortOrders": {
"items": {
"$ref": "#/definitions/The representation of the sorting to apply to the search results."
},
"type": "array",
"description": "The array of sorts associated to the search."
},
"searchTreeFilters": {
"items": {
"$ref": "#/definitions/The representation of the tree filter to associate with the search."
},
"type": "array",
"description": "The array of tree filters configured to the search."
},
"id": {
"type": "string",
"description": "The ID of the search."
},
"name": {
"type": "string",
"description": "The name of the search."
}
}
},
"The representation of the parameter objects associated with a subsearch.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of this parameter with respect to other parameters in the search.",
"format": "int32"
},
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "The connector that is used to connect this parameter and the parameter that occurs directly before this parameter when ordered by their parameter ordinal values within the search."
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string",
"description": "The type of the metadata associated with this parameter. If the parameter is not associated to metadata, then this field will be NULL."
},
"numericValue": {
"type": "integer",
"description": "The numeric value of the parameter, when the parameter is a INTEGER data type. If the data type of the parameter is not a integer, this value should be NULL.",
"format": "int32"
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string",
"description": "The comparator operator used in the execution and resolution of this parameter."
},
"searchPromptName": {
"type": "string",
"description": "The name of the search prompt used in the execution of this parameter. This is the unique identifier (with a particular search) of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute (data) associated with this parameter."
},
"closingParen": {
"type": "string",
"description": "The representation of closing parenthesis that will end groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL."
},
"openingParen": {
"type": "string",
"description": "The representation of opening parenthesis that will begin groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL."
},
"searchPromptId": {
"type": "string",
"description": "The ID of the search prompt used in the execution of this parameter. This is the unique identifier of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication as to whether or not to delete this parameter from the search."
},
"attributeId": {
"type": "string",
"description": "The ID of the attribute (data) associated with this parameter. If the data is non-metadata, then this ID will be NULL."
},
"sortOrder": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string",
"description": "The sort order associated with this parameter. NOTE: This value is no longer used because of SearchSortOrder."
},
"dateValue": {
"type": "string",
"description": "The date value of the parameter, when the parameter is a DATE data type. If the data type of the parameter is not a date, this value should be NULL.",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"description": "The decimal value of the parameter, when the parameter is a DECIMAL data type. If the data type of the parameter is not a decimal, this value should be NULL.",
"format": "double"
},
"strValue": {
"type": "string",
"description": "The string value of the parameter, when the parameter is a STRING data type. If the data type of the parameter is not a string, this value should be NULL."
},
"type": {
"enum": [
"PROMPTED",
"STATIC",
"MACRO",
"CUSTOM"
],
"type": "string",
"description": "The type of the parameter, indicating what needs to be associated to the parameter. Static static parameter will associate a static value with the parameter. A prompted parameter will require input from a user prompt. A custom parameter will require input from multiple sources to do a sub-select query from other tables to retrieve values to use in the search."
},
"id": {
"type": "string",
"description": "The ID of the parameter associated with the search."
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The type of the attribute used by the parameter."
}
}
},
"An object representing the collection of document type to metadata associations.": {
"type": "object",
"properties": {
"includeDocTypeMetadataFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating that document type to metadata relationship should be acted upon during any CRUD operations."
},
"adminDocsTypesFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating whether or not the save should perform additional administration functions on the documents and metadata if applicable. This may be expensive in terms of time so treat with caution."
},
"docTypeMetadataDtos": {
"items": {
"$ref": "#/definitions/An object representing a piece of metadata that is assigned to a specific document type."
},
"type": "array",
"description": "The ID of the document type metadata."
},
"includeIndexingConfigurationFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating that indexing configuration should be acted upon during any CRUD operations."
}
}
},
"SearchFormData": {
"required": [
"formControlName",
"search",
"value"
],
"type": "object",
"properties": {
"search": {
"$ref": "#/definitions/Search"
},
"isNew": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formControlName": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"Sort column configuration for report importer.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal associated with the sort column.",
"format": "int32"
},
"field": {
"type": "integer",
"description": "The field number associated with report importer sort column.",
"format": "int32"
},
"direction": {
"type": "string",
"description": "The sort direction associated with the sort column, ASC/DESC."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag indicating the column has been marked for deletion."
},
"id": {
"type": "string",
"description": "The id associated with report importer sort column."
}
}
},
"LicenseEmailDTO": {
"type": "object",
"properties": {
"threshold": {
"type": "integer",
"format": "int32"
},
"emailFrequency": {
"enum": [
"NEVER",
"DAILY",
"WEEKLY",
"MONTHLY"
],
"type": "string"
},
"days": {
"type": "integer",
"format": "int32"
}
}
},
"RenderDashboardContentDTO": {
"type": "object",
"properties": {
"layout": {
"description": "The layout position for this chart.",
"$ref": "#/definitions/An object that defines the layout of a chart on a dashboard."
},
"id": {
"type": "string",
"description": "The ID of the DashboardChartable object to render."
}
}
},
"DocumentType": {
"required": [
"description",
"name",
"retentionPolicy",
"status"
],
"type": "object",
"properties": {
"category": {
"$ref": "#/definitions/Category"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string"
},
"fullText": {
"default": false,
"type": "boolean"
},
"documents": {
"items": {
"$ref": "#/definitions/Document"
},
"type": "array"
},
"documentTypeScanSettings": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentTypeScanSetting"
},
"type": "array"
},
"name": {
"type": "string"
},
"documentTypeProcessModels": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentTypeProcessModel"
},
"type": "array"
},
"retentionPolicy": {
"$ref": "#/definitions/RetentionPolicy"
},
"nameChanged": {
"default": false,
"type": "boolean"
},
"documentTypeMetadatas": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"type": "array"
},
"validateRetentionPolicyMetadata": {
"default": false,
"type": "boolean"
},
"fullTextChanged": {
"default": false,
"type": "boolean"
},
"version": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"originalName": {
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"distinctiveName": {
"type": "string"
},
"documentTypeGroups": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentTypeGroup"
},
"type": "array"
},
"documentTypeOverlays": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DocumentTypeOverlay"
},
"type": "array"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"Connection": {
"type": "object",
"properties": {
"autoCommit": {
"default": false,
"type": "boolean"
},
"clientInfo": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"warnings": {
"$ref": "#/definitions/SQLWarning"
},
"holdability": {
"type": "integer",
"format": "int32"
},
"transactionIsolation": {
"type": "integer",
"format": "int32"
},
"catalog": {
"type": "string"
},
"readOnly": {
"default": false,
"type": "boolean"
},
"networkTimeout": {
"type": "integer",
"format": "int32"
},
"closed": {
"default": false,
"type": "boolean"
},
"schema": {
"type": "string"
},
"typeMap": {
"type": "object"
},
"metaData": {
"$ref": "#/definitions/DatabaseMetaData"
}
}
},
"Representation of a DocFinity category.": {
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string",
"description": "The status of the category."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The flag to indicate whether or not the category is to be deleted."
},
"description": {
"type": "string",
"description": "The description of the category."
},
"name": {
"type": "string",
"description": "The unique name of the category."
},
"id": {
"type": "string",
"description": "The unique identifier of the category."
}
}
},
"DocumentTypeMetadataValidator": {
"type": "object",
"properties": {
"documentTypeMetadata": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"validator": {
"$ref": "#/definitions/Validator"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"Enterprise search configuration.": {
"type": "object",
"properties": {
"extractionUseFastPdf": {
"default": false,
"type": "boolean",
"description": "This setting controls whether fulltext searches should use non-OCR PDF extraction."
},
"orphanNewestFirst": {
"default": false,
"type": "boolean",
"description": "This system property sets the processing order of orphaned documents."
},
"searchServerURL": {
"type": "string",
"description": "Enterprise search web service URL."
},
"orphanWindowSize": {
"type": "integer",
"description": "The window size is the number of items returned from the orphan checker process.",
"format": "int32"
},
"highlightFragSize": {
"type": "integer",
"description": "This setting controls the baseline number of characters returned in a hit fragment.",
"format": "int32"
},
"ocrWebServiceURL": {
"type": "string",
"description": "OCR web service URL."
},
"extractionForceMemoryPayload": {
"default": false,
"type": "boolean",
"description": "Set to true if all files should be sent as byte streams."
},
"highlightShow": {
"default": false,
"type": "boolean",
"description": "This setting controls whether fulltext searches should display hit highlights."
}
}
},
"The definition of the database schema and tables within that schema.": {
"type": "object",
"properties": {
"databaseConnectionId": {
"type": "string",
"description": "The database connection id."
},
"schemaName": {
"type": "string",
"description": "The schema name in the database."
},
"tableName": {
"type": "string",
"description": "The table name in the database."
}
}
},
"MetadataValueCustomParameterValue": {
"required": [
"attributeType"
],
"type": "object",
"properties": {
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string"
},
"numericValue": {
"type": "integer",
"format": "int32"
},
"attributeName": {
"type": "string"
},
"attributeId": {
"type": "string"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"dateValue": {
"type": "string",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"format": "double"
},
"strValue": {
"type": "string"
},
"promptName": {
"type": "string"
}
}
},
"Metadata data used to configure metadatas for the system.": {
"type": "object",
"properties": {
"isCollection": {
"default": false,
"type": "boolean",
"description": "The boolean flag indicates if metadata supports a collection of values."
},
"decimalPrecision": {
"type": "integer",
"description": "The decimal precision of the value the metadata can hold.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the metadata."
},
"minLength": {
"type": "integer",
"description": "The minimum length of the value the metadata can hold.",
"format": "int32"
},
"isCurrency": {
"default": false,
"type": "boolean",
"description": "The boolean flag indicates if metadata is for a currency."
},
"currencyLocale": {
"type": "string",
"description": "The currency locale of the metadata."
},
"length": {
"type": "integer",
"description": "The length of the value the metadata can hold.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"maxLength": {
"type": "integer",
"description": "The maximum length of the value the metadata can hold.",
"format": "int32"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string",
"description": "The type of metadata."
},
"shortName": {
"type": "string",
"description": "The short name of the metadata."
},
"id": {
"type": "string",
"description": "The ID of the metadata configuration data."
},
"name": {
"type": "string",
"description": "The name of the metadata."
}
}
},
"A generic result object that can be used to return instances of List and Map.": {
"type": "object"
},
"Wrapper class used to hold both standard form version details as well as separate properties that provide details for the Form's working copy.": {
"type": "object",
"properties": {
"workingCopy": {
"description": "Details about the working copy of the form.",
"$ref": "#/definitions/Dto object that populates the initial form monitoring screen."
},
"versions": {
"description": "Paged collection of form version details.",
"$ref": "#/definitions/A paged collection of search results for some entity.Dto Object That Populates The Initial Form Monitoring Screen."
}
}
},
"A username and IP address identifier used to revoke licenses for a specific user on a specific host.": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "Username to revoke."
},
"ipAddress": {
"type": "string",
"description": "Unique identifier representing the host device using the license."
}
}
},
"An object representing a datasource and data to test.": {
"type": "object",
"properties": {
"parameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Array of parameters to use during testing."
},
"datasourceDto": {
"description": "Representation of the datasource.",
"$ref": "#/definitions/The definition of a data source."
}
}
},
"SearchPromptDatasourceParam": {
"required": [
"searchPromptDatasource"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"value": {
"type": "string"
},
"datasourceParameterName": {
"type": "string"
},
"searchPromptDatasource": {
"$ref": "#/definitions/SearchPromptDatasource"
},
"type": {
"enum": [
"NONE",
"STATIC",
"MACRO",
"PROMPT"
],
"type": "string"
},
"id": {
"type": "string"
}
}
},
"FormStep": {
"required": [
"name",
"ordinal"
],
"type": "object",
"properties": {
"ordinal": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"form": {
"$ref": "#/definitions/Form"
},
"deletedFormControlSteps": {
"items": {
"$ref": "#/definitions/FormControlStep"
},
"type": "array"
},
"deleted": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formControlSteps": {
"items": {
"$ref": "#/definitions/FormControlStep"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"An object representing the parameters and values to use during the execution of tree filters associated with the search.": {
"type": "object",
"properties": {
"sortOrder": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string",
"description": "The sort associated with the tree."
},
"numericValue": {
"type": "integer",
"description": "The numeric integer value selected from the tree.",
"format": "int32"
},
"attributeName": {
"type": "string"
},
"label": {
"type": "string",
"description": "The label associated to the level of the tree."
},
"isLastLevelFlag": {
"default": false,
"type": "boolean",
"description": "The indication that the selected level is the last level of the tree."
},
"searchTreeFilterId": {
"type": "string",
"description": "The ID of the selected level associated with the tree."
},
"strValue": {
"type": "string",
"description": "The string value selected from the tree."
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The attribute type of the specific level of the tree."
},
"dateValue": {
"type": "string",
"description": "The date selected from the tree.",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"description": "The decimal value selected from the tree.",
"format": "double"
},
"includeInCriteriaFlag": {
"default": false,
"type": "boolean",
"description": "The indication to use the selected tree filter level in the execution of the search."
},
"documentCount": {
"type": "integer",
"description": "The document count associated with the specific level of the tree.",
"format": "int32"
},
"metadata": {
"description": "The metadata associated to the level of the tree.",
"$ref": "#/definitions/Metadata data used to configure metadatas for the system."
}
}
},
"Configuration details for an exporter server.": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The url of the exporter server"
},
"serverName": {
"type": "string",
"description": "The servername of the exporter server"
},
"isSecureHttp": {
"default": false,
"type": "boolean",
"description": "Flag indicating exporter server url is secure"
},
"id": {
"type": "string",
"description": "The id of the exporter server"
},
"port": {
"type": "integer",
"description": "The port of the exporter server",
"format": "int32"
}
}
},
"The representation of an Importer object.": {
"discriminator": "_class",
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The importer status INTERNAL/EXTERNAL."
},
"preRender": {
"default": false,
"type": "boolean",
"description": "Flag indicating that files imported by the importer will be pre-rendered."
},
"calculatedProperties": {
"items": {
"$ref": "#/definitions/The representation of the calculated property associated with the importer."
},
"type": "array",
"description": "The calculated properties to be used by the importer."
},
"importerPluginName": {
"type": "string",
"description": "The plugin to be used by the importer."
},
"description": {
"type": "string",
"description": "The description to be used by the importer."
},
"schedule": {
"description": "The importer schedule.",
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"get_class": {
"type": "string"
},
"idle": {
"default": false,
"type": "boolean",
"description": "Flag indicating importer is running but not processing."
},
"server": {
"type": "string",
"description": "The server details where the importer will run."
},
"running": {
"default": false,
"type": "boolean",
"description": "Flag indicating that the importer is running."
},
"pollingUnits": {
"enum": [
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"type": "string",
"description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS."
},
"lastErrorMessage": {
"type": "string",
"description": "The last error message associated with the importer."
},
"pollingFrequency": {
"type": "integer",
"description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder.",
"format": "int32"
},
"ruleSets": {
"items": {
"$ref": "#/definitions/The rule set associated with the importer."
},
"type": "array",
"description": "The rulesets to be used by the importer."
},
"processType": {
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"type": "string",
"description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX."
},
"id": {
"type": "string",
"description": "The id of the importer."
},
"pending": {
"default": false,
"type": "boolean",
"description": "Flag indicating that start/stop of importer is pending."
},
"name": {
"type": "string",
"description": "The name of the importer."
}
}
},
"SearchResultLinkedMetadata": {
"required": [
"columnName",
"datasource",
"searchResultMetadata"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"searchResultMetadata": {
"$ref": "#/definitions/SearchResultColumn"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"columnName": {
"type": "string"
},
"datasource": {
"$ref": "#/definitions/Datasource"
},
"id": {
"type": "string"
}
}
},
"A representation of the wsdl url object that can be applied to get requests.": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The url of the webservice."
},
"username": {
"type": "string",
"description": "The username of the webservice."
},
"password": {
"type": "string",
"description": "The password of the webservice."
},
"id": {
"type": "string",
"description": "The ID of the webservice."
},
"name": {
"type": "string",
"description": "The name of the webservice."
}
}
},
"DataSource": {
"type": "object",
"properties": {
"outputStream": {
"$ref": "#/definitions/OutputStream"
},
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"inputStream": {
"$ref": "#/definitions/InputStream"
}
}
},
"FeatureRight": {
"required": [
"description",
"name",
"permissionClassification",
"permissionKey",
"permissionType"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"permissionClassification": {
"$ref": "#/definitions/PermissionClassification"
},
"groups": {
"items": {
"$ref": "#/definitions/Group"
},
"type": "array"
},
"permissionKey": {
"type": "string"
},
"permissionType": {
"enum": [
"FEATURE_RIGHT",
"GROUP_ADMINISTRATION",
"SYSTEM_ACCESS"
],
"type": "string"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"SearchChecklistSubSearch": {
"required": [
"ordinal",
"required",
"search"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"searchParameters": {
"items": {
"$ref": "#/definitions/SearchSubSearchParameter"
},
"type": "array"
},
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
}
}
},
"ValidatorPluginDTO": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"configResourcePath": {
"type": "string"
},
"entryControlResourcePath": {
"type": "string"
},
"validatorType": {
"type": "string"
}
}
},
"FormLibraryDTO": {
"type": "object",
"properties": {
"numInstances": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
}
},
"ChecklistSearchResultDTO": {
"type": "object",
"properties": {
"fulfilled": {
"default": false,
"type": "boolean"
},
"searchDisplayName": {
"type": "string"
},
"subSearches": {
"items": {
"$ref": "#/definitions/A generic object that holds a collection of grouped items to be returned via JSON. Generally used when retrieving items in conjunction with a Kendo DataSource grouped by a String name."
},
"type": "array"
},
"totalAvailable": {
"type": "integer",
"format": "int32"
}
}
},
"SearchPromptValueDTO": {
"required": [
"attributeName",
"attributeType"
],
"type": "object",
"properties": {
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"numericValue": {
"type": "integer",
"format": "int32"
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string"
},
"attributeName": {
"type": "string"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string"
},
"searchPromptId": {
"type": "string"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"dateValue": {
"type": "string",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"format": "double"
},
"strValue": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"WsdlServicesDTO": {
"type": "object",
"properties": {
"services": {
"xml": {
"name": "service"
},
"items": {
"$ref": "#/definitions/ServiceDTO"
},
"type": "array"
}
}
},
"An object defining the font used in a chart title.": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The font color."
},
"size": {
"type": "integer",
"description": "The font size.",
"format": "int32"
}
}
},
"A column returned by a datasource that is used in a chart.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this column should be deleted."
},
"id": {
"type": "string",
"description": "The ID of the chart column."
},
"name": {
"type": "string",
"description": "The column name from the datasource result."
}
}
},
"An object that defines print or fax server.": {
"required": [
"isSecureHttp",
"port",
"serverName",
"serverType"
],
"type": "object",
"properties": {
"serverType": {
"enum": [
"PRINTER",
"FAX"
],
"type": "string",
"description": "The server type."
},
"serverName": {
"type": "string",
"description": "The physical name or IP address of the server."
},
"isSecureHttp": {
"default": false,
"type": "boolean",
"description": "Whether to access the server over HTTPS."
},
"id": {
"type": "string",
"description": "The unique ID of the server."
},
"port": {
"type": "integer",
"description": "The port number used to access the server.",
"format": "int32"
}
}
},
"The representation of the sorting to apply to the search results.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of this sort order with respect to other sort order in the search.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication as to whether or not to delete this sort order from the search."
},
"name": {
"type": "string",
"description": "The name of the sort order."
},
"customValues": {
"items": {
"$ref": "#/definitions/The representation of the custom search sort order when ascending or descending order is not sufficient."
},
"type": "array",
"description": "The array of custom values to use in the sort order, when ascending or descending order is not sufficient."
},
"orderType": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string",
"description": "The order of the sort (ASC, DESC, or CUSTOM) for this sort order."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute used in the sort. This field is only applicable when the attribute is a metadata type. Any other attribute type will return a value of NULL for the name."
},
"attributeDataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string",
"description": "The data type of the attribute used in the sort."
},
"attributeId": {
"type": "string",
"description": "The ID of the attribute used in the sort. This field is only applicable when the attribute is a metadata type. Any other attribute type will return a value of NULL for the ID."
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The type of the attributed used in the sort."
},
"id": {
"type": "string",
"description": "The ID of the sort order."
}
}
},
"MetadataValueDTO": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"numericValue": {
"type": "integer",
"format": "int32"
},
"metadataId": {
"type": "string"
},
"isCurrency": {
"default": false,
"type": "boolean"
},
"decimalPrecision": {
"type": "integer",
"format": "int32"
},
"metadataName": {
"type": "string"
},
"id": {
"type": "string"
},
"currencyLocale": {
"type": "string"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string"
},
"strValue": {
"type": "string"
},
"dateValue": {
"type": "string",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"format": "double"
},
"documentCount": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "string"
}
}
},
"The dto representation of a holiday.": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "The holiday start date.",
"format": "date-time"
},
"end": {
"type": "string",
"description": "The holiday end date as a system date formatted string."
},
"title": {
"type": "string",
"description": "The holiday name."
},
"start": {
"type": "string",
"description": "The holiday start date as a system date formatted string."
},
"endDate": {
"type": "string",
"description": "The holiday end date.",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The holiday ID."
}
}
},
"SecurityFilter": {
"required": [
"comparatorType",
"documentSecurity",
"metadata",
"ordinal",
"value"
],
"type": "object",
"properties": {
"ordinal": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string"
},
"value": {
"type": "string"
},
"documentSecurity": {
"$ref": "#/definitions/DocumentSecurity"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"A paged search result for groups.": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"xml": {
"name": "result"
},
"items": {
"$ref": "#/definitions/An object representing a group."
},
"type": "array",
"description": "A page of group search results."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"DatasourceResult": {
"type": "object",
"properties": {
"targetName": {
"type": "string"
},
"results": {
"items": {
"$ref": "#/definitions/DatasourceResultDTO"
},
"type": "array"
}
}
},
"A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource.": {
"type": "object",
"properties": {
"results": {
"items": {
"type": "object"
},
"type": "array",
"description": "The collection of items."
}
}
},
"The DTO object for a Shift.": {
"type": "object",
"properties": {
"shiftParts": {
"items": {
"$ref": "#/definitions/ShiftPartDTO"
},
"type": "array",
"description": "Gets the shiftParts attribute of the ShiftDTO object."
},
"shiftMembers": {
"items": {
"$ref": "#/definitions/DTO that contains information about a member of a shift."
},
"type": "array",
"description": "Gets the shiftMembers attribute of the ShiftDTO object."
},
"description": {
"type": "string",
"description": "Gets the description attribute of the ShiftDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the ShiftDTO object."
},
"name": {
"type": "string",
"description": "Gets the name attribute of the ShiftDTO object."
}
}
},
"A DocFinity system property used to control a setting for the system.": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The system property category. Read-only."
},
"enumValues": {
"items": {
"type": "string"
},
"type": "array"
},
"prompt": {
"type": "string",
"description": "The system property prompt value. Read-only."
},
"name": {
"type": "string",
"description": "The system property name. Read-only."
},
"min": {
"type": "string",
"description": "The system property min value. Read-only."
},
"generic": {
"default": false,
"type": "boolean",
"description": "Whether the system property is generic. Read-only."
},
"max": {
"type": "string",
"description": "The system property max value. Read-only."
},
"defaultValue": {
"type": "string",
"description": "The system property default value, used during reset operations. Read-only."
},
"description": {
"type": "string",
"description": "The system property description. Read-only."
},
"value": {
"type": "string",
"description": "The system property value."
},
"units": {
"type": "string",
"description": "The system property units. Read-only."
},
"type": {
"type": "string",
"description": "The system property data type. Read-only."
},
"id": {
"type": "string",
"description": "The ID of the system property. Read-only."
},
"subcategory": {
"type": "string",
"description": "The system property subcategory. Read-only."
}
}
},
"SearchParameter": {
"required": [
"attributeName",
"attributeType",
"comparatorType",
"ordinal",
"search",
"sortOrder"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string"
},
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"searchPrompt": {
"$ref": "#/definitions/SearchPrompt"
},
"validateContains": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string"
},
"attributeName": {
"type": "string"
},
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"type": "string"
},
"closingParen": {
"type": "string"
},
"openingParen": {
"type": "string"
},
"customReferences": {
"uniqueItems": true,
"items": {
"type": "string"
},
"type": "array"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"type": {
"enum": [
"PROMPTED",
"STATIC",
"MACRO",
"CUSTOM"
],
"type": "string"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"LegalHold": {
"required": [
"dateCreated",
"document",
"legalHoldCase",
"user"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"user": {
"$ref": "#/definitions/User"
},
"legalHoldCase": {
"$ref": "#/definitions/LegalHoldCase"
},
"document": {
"$ref": "#/definitions/Document"
},
"id": {
"type": "string"
}
}
},
"The representation of the search result linked output column.": {
"type": "object",
"properties": {
"columnName": {
"type": "string",
"description": "The name of the linked output column."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication of the intent to delete the search result linked output column."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource associated with the linked output column."
},
"id": {
"type": "string",
"description": "The unique identifier of the search result linked output column."
}
}
},
"An object representing a group containing the group id, group name and the number of active members in the group.": {
"type": "object",
"properties": {
"numberOfUsersInGroup": {
"type": "integer",
"description": "The number of active users in the group.",
"format": "int32"
},
"id": {
"type": "string",
"description": "The group ID."
},
"name": {
"type": "string",
"description": "The group name."
}
}
},
"An object representing a group.": {
"type": "object",
"properties": {
"groupType": {
"enum": [
"INTERNAL",
"BATCH",
"DISTRIBUTION",
"FORM"
],
"type": "string",
"description": "The type of group."
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"INTERNAL",
"DELETED"
],
"type": "string",
"description": "The group status."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"description": {
"type": "string",
"description": "The group description."
},
"groupAssociationLevel": {
"enum": [
"ALL",
"PARTIAL",
"NONE"
],
"type": "string",
"description": "The group association level."
},
"external": {
"default": false,
"type": "boolean",
"description": "Whether the group is managed by an external system such as LDAP."
},
"id": {
"type": "string",
"description": "The group ID."
},
"name": {
"type": "string",
"description": "The group name."
}
}
},
"The plot configuration for a chart.": {
"type": "object",
"properties": {
"colors": {
"items": {
"$ref": "#/definitions/A series color for a chart."
},
"type": "array",
"description": "The series color definitions."
},
"includeValue": {
"default": false,
"type": "boolean",
"description": "Whether to include the item value on the plot."
},
"maxLabels": {
"type": "integer",
"description": "The maximum number of labels to show.",
"format": "int32"
},
"includeName": {
"default": false,
"type": "boolean",
"description": "Whether to include the item name on the plot."
}
}
},
"The definition of the database schema.": {
"type": "object",
"properties": {
"databaseConnectionId": {
"type": "string",
"description": "The database connection id."
},
"schemaName": {
"type": "string",
"description": "The schema name in the database."
}
}
},
"SystemTransferStatusDTO": {
"required": [
"running"
],
"type": "object",
"properties": {
"progress": {
"type": "integer",
"description": "The percentage complete of the system transfer import.",
"format": "int64"
},
"running": {
"default": false,
"type": "boolean",
"description": "Whether or not something is importing on this node."
}
}
},
"DocumentTypeOverlay": {
"required": [
"defaultTo",
"documentType",
"offsetX",
"offsetY",
"overlay",
"range"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"overlay": {
"$ref": "#/definitions/Overlay"
},
"offsetX": {
"type": "integer",
"format": "int32"
},
"offsetY": {
"type": "integer",
"format": "int32"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultTo": {
"default": false,
"type": "boolean"
},
"range": {
"type": "string"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"id": {
"type": "string"
}
}
},
"A static hidden boolean input.": {
"allOf": [
{
"$ref": "#/definitions/A static hidden input to a dashboard."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"staticType": {
"enum": [
"BOOLEAN",
"DATE",
"DECIMAL",
"INTEGER",
"STRING"
],
"type": "string",
"description": "The type of static input."
},
"value": {
"type": "object"
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"booleanValue": {
"default": false,
"type": "boolean",
"description": "The static boolean value."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"A COLD importer.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"type": "object",
"properties": {
"directoryPath": {
"type": "string",
"description": "The directory path being monitored by the importer."
},
"narratives": {
"items": {
"$ref": "#/definitions/The cold narrative configuration"
},
"type": "array",
"description": "The cold narrative associated with the importer."
},
"importerPluginName": {
"type": "string",
"description": "The plugin to be used by the importer."
},
"get_class": {
"type": "string"
},
"ruleSets": {
"items": {
"$ref": "#/definitions/The rule set associated with the importer."
},
"type": "array",
"description": "The rulesets to be used by the importer."
},
"pollingFrequency": {
"type": "integer",
"description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder.",
"format": "int32"
},
"serial": {
"default": false,
"type": "boolean",
"description": "Flag indicating the files are to be processed serially."
},
"id": {
"type": "string",
"description": "The id of the importer."
},
"preRender": {
"default": false,
"type": "boolean",
"description": "Flag indicating that files imported by the importer will be pre-rendered."
},
"fileFilter": {
"type": "string",
"description": "The file filter to be used by the importer."
},
"processType": {
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"type": "string",
"description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX."
},
"pending": {
"default": false,
"type": "boolean",
"description": "Flag indicating that start/stop of importer is pending."
},
"status": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The importer status INTERNAL/EXTERNAL."
},
"calculatedProperties": {
"items": {
"$ref": "#/definitions/The representation of the calculated property associated with the importer."
},
"type": "array",
"description": "The calculated properties to be used by the importer."
},
"description": {
"type": "string",
"description": "The description to be used by the importer."
},
"schedule": {
"description": "The importer schedule.",
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"running": {
"default": false,
"type": "boolean",
"description": "Flag indicating that the importer is running."
},
"pollingUnits": {
"enum": [
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"type": "string",
"description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS."
},
"lastErrorMessage": {
"type": "string",
"description": "The last error message associated with the importer."
},
"name": {
"type": "string",
"description": "The name of the importer."
},
"server": {
"type": "string",
"description": "The server details where the importer will run."
},
"idle": {
"default": false,
"type": "boolean",
"description": "Flag indicating importer is running but not processing."
}
}
}
]
},
"ValidateStatus": {
"type": "object",
"properties": {
"validateStatusType": {
"enum": [
"VALID",
"ERROR",
"WARNING"
],
"type": "string"
},
"message": {
"type": "string"
}
}
},
"A report importer.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"type": "object",
"properties": {
"directoryPath": {
"type": "string",
"description": "The directory path being monitored by the importer."
},
"mergeContiguous": {
"default": false,
"type": "boolean",
"description": "Flag to indicate if continguous values are to be merged."
},
"importerPluginName": {
"type": "string",
"description": "The plugin to be used by the importer."
},
"get_class": {
"type": "string"
},
"ruleSets": {
"items": {
"$ref": "#/definitions/The rule set associated with the importer."
},
"type": "array",
"description": "The rulesets to be used by the importer."
},
"pollingFrequency": {
"type": "integer",
"description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder.",
"format": "int32"
},
"serial": {
"default": false,
"type": "boolean",
"description": "Flag indicating the files are to be processed serially."
},
"id": {
"type": "string",
"description": "The id of the importer."
},
"headerLineProperties": {
"items": {
"$ref": "#/definitions/A report importer header line property."
},
"type": "array",
"description": "The headlines associated with the report."
},
"preRender": {
"default": false,
"type": "boolean",
"description": "Flag indicating that files imported by the importer will be pre-rendered."
},
"driveLetter": {
"type": "string",
"description": "The drive letter where raw report are held."
},
"fileFilter": {
"type": "string",
"description": "The file filter to be used by the importer."
},
"reportType": {
"enum": [
"SHORT_REPORT",
"LONG_REPORT",
"PDF_REPORT"
],
"type": "string",
"description": "The report type for the report importer SHORT_REPORT, LONG_REPORT or PDF_REPORT."
},
"processType": {
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"type": "string",
"description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX."
},
"pending": {
"default": false,
"type": "boolean",
"description": "Flag indicating that start/stop of importer is pending."
},
"status": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The importer status INTERNAL/EXTERNAL."
},
"calculatedProperties": {
"items": {
"$ref": "#/definitions/The representation of the calculated property associated with the importer."
},
"type": "array",
"description": "The calculated properties to be used by the importer."
},
"description": {
"type": "string",
"description": "The description to be used by the importer."
},
"schedule": {
"description": "The importer schedule.",
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"endPageField": {
"type": "integer",
"description": "Field holding the end page of the report document.",
"format": "int32"
},
"compareFields": {
"type": "string",
"description": "Flag to indicate if fields are to be compared."
},
"running": {
"default": false,
"type": "boolean",
"description": "Flag indicating that the importer is running."
},
"lineProperties": {
"items": {
"$ref": "#/definitions/A property used in an importer."
},
"type": "array",
"description": "The line properties associated with the report."
},
"pollingUnits": {
"enum": [
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"type": "string",
"description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS."
},
"lastErrorMessage": {
"type": "string",
"description": "The last error message associated with the importer."
},
"name": {
"type": "string",
"description": "The name of the importer."
},
"sortColumns": {
"items": {
"$ref": "#/definitions/Sort column configuration for report importer."
},
"type": "array",
"description": "The sort columns associated with the report."
},
"mergeFields": {
"items": {
"$ref": "#/definitions/Configuration information for report importer merge fields."
},
"type": "array",
"description": "The merge columns associated with the report."
},
"uploadRepositoryPath": {
"type": "string",
"description": "The upload repository path for the report importer."
},
"startPageField": {
"type": "integer",
"description": "Field holding the start page of the report document.",
"format": "int32"
},
"server": {
"type": "string",
"description": "The server details where the importer will run."
},
"idle": {
"default": false,
"type": "boolean",
"description": "Flag indicating importer is running but not processing."
},
"uncPath": {
"type": "string",
"description": "The UNC path where the raw reports are held."
},
"pathField": {
"type": "integer",
"description": "The field that holds path information in the report index file.",
"format": "int32"
}
}
}
]
},
"MetadataValueCriteria": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"searchPromptId": {
"type": "string"
},
"documentIds": {
"items": {
"type": "string"
},
"type": "array"
},
"openingParenCount": {
"type": "integer",
"format": "int32"
},
"closingParen": {
"type": "string"
},
"currencyLocale": {
"type": "string"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"decimalValue": {
"type": "number",
"format": "double"
},
"numericValue": {
"type": "integer",
"format": "int32"
},
"categoryIds": {
"items": {
"type": "string"
},
"type": "array"
},
"searchPromptName": {
"type": "string"
},
"connective": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"customParameterValues": {
"items": {
"$ref": "#/definitions/MetadataValueCustomParameterValue"
},
"type": "array"
},
"documentTypeIds": {
"items": {
"type": "string"
},
"type": "array"
},
"documentSecurityId": {
"type": "string"
},
"parameterType": {
"enum": [
"PROMPTED",
"STATIC",
"MACRO",
"CUSTOM"
],
"type": "string"
},
"isCurrency": {
"default": false,
"type": "boolean"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string"
},
"attributeName": {
"type": "string"
},
"precision": {
"type": "integer",
"format": "int32"
},
"openingParen": {
"type": "string"
},
"value": {
"type": "object"
},
"dateValue": {
"type": "string",
"format": "date-time"
},
"useInSearch": {
"default": false,
"type": "boolean"
},
"comparator": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string"
},
"metadataId": {
"type": "string"
},
"fullTextResultId": {
"type": "string"
},
"closingParenCount": {
"type": "integer",
"format": "int32"
},
"metadataShortName": {
"type": "string"
},
"strValue": {
"type": "string"
},
"customSql": {
"type": "string"
}
}
},
"ShiftPartDTO": {
"type": "object",
"properties": {
"endHour": {
"type": "integer",
"format": "int32"
},
"endDay": {
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": "string"
},
"startDay": {
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": "string"
},
"startMinute": {
"type": "integer",
"format": "int32"
},
"endMinute": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"startHour": {
"type": "integer",
"format": "int32"
}
}
},
"A variable exposed as required input to a chart.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of the variable.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether the variable should be deleted."
},
"name": {
"type": "string",
"description": "The name of the variable."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type of the variable."
},
"testValue": {
"type": "string",
"description": "A test value for the variable."
},
"id": {
"type": "string",
"description": "The chart variable ID."
}
}
},
"The definition of a data source properties.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The deleted flag of the datasource property."
},
"displayName": {
"type": "string",
"description": "The display name of the datasource property."
},
"name": {
"type": "string",
"description": "The name of the datasource property."
},
"value": {
"items": {
"type": "string"
},
"type": "array",
"description": "The value of the datasource property."
},
"datasourceId": {
"type": "string",
"description": "The datasource id of the datasource property."
},
"displayValue": {
"type": "string",
"description": "The display value of the datasource property."
},
"id": {
"type": "string",
"description": "The id of the datasource property."
}
}
},
"Dto object for the summary of a FormInstance.": {
"type": "object",
"properties": {
"originator": {
"type": "string",
"description": "Gets the originator attribute of the FormInstanceSummaryDTO object."
},
"lockOwnerLastName": {
"type": "string",
"description": "The last name of the lock owner, if available."
},
"createDate": {
"type": "integer",
"description": "Gets the createDate attribute of the FormInstanceSummaryDTO object.",
"format": "int64"
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the lock owner, if available."
},
"originatorFirstName": {
"type": "string",
"description": "The first name of the originator, if available."
},
"dateModified": {
"type": "integer",
"description": "Gets the dateModified attribute of the FormInstanceSummaryDTO object.",
"format": "int64"
},
"originatorLastName": {
"type": "string",
"description": "The last name of the originator, if available."
},
"lastModifiedUser": {
"type": "string",
"description": "Gets the lastModifiedUser attribute of the FormInstanceSummaryDTO object."
},
"lastModifiedUserLastName": {
"type": "string",
"description": "The last name of the last acting user, if available."
},
"lastModifiedUserFirstName": {
"type": "string",
"description": "The first name of the last acting user, if available."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the FormInstanceSummaryDTO object."
},
"lockOwner": {
"type": "string",
"description": "Gets the lockOwner attribute of the FormInstanceSummaryDTO object."
}
}
},
"An object that encapsulates all of the display properties for a chart.": {
"type": "object",
"properties": {
"tooltips": {
"description": "The tooltip properties.",
"$ref": "#/definitions/Configuration for the tooltips for a chart."
},
"plot": {
"description": "The plot properties.",
"$ref": "#/definitions/The plot configuration for a chart."
},
"scale": {
"description": "The scale properties.",
"$ref": "#/definitions/An object containing a chart's scale configuration."
},
"title": {
"description": "The title properties.",
"$ref": "#/definitions/An object that defines the title of a chart."
},
"chart": {
"description": "The chart properties.",
"$ref": "#/definitions/An object that holds general properties for the chart."
},
"backgroundColor": {
"type": "string",
"description": "The background color for the chart."
},
"legend": {
"description": "The legend properties.",
"$ref": "#/definitions/An object containing the configuration for a chart legend."
}
}
},
"Process model name information.": {
"type": "object",
"properties": {
"viewId": {
"type": "string",
"description": "The view id associated with the process model name configuration data."
},
"id": {
"type": "string",
"description": "The ID of the process model name configuration data."
},
"name": {
"type": "string",
"description": "The name associated with the process model name configuration data."
}
}
},
"A property used in an importer.": {
"discriminator": "_class",
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal associated with the property.",
"format": "int32"
},
"trim": {
"default": false,
"type": "boolean",
"description": "Flag indicating the property value needs to be trimmed."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag indicating the property is marked for deletion."
},
"name": {
"type": "string",
"description": "The name associated with the property."
},
"textCase": {
"type": "string",
"description": "The text case associated with the property."
},
"dataType": {
"type": "string",
"description": "The data type associated with the property."
},
"defaultValue": {
"type": "string",
"description": "The default value of the property."
},
"format": {
"type": "string",
"description": "The date format associated with the property."
},
"field": {
"type": "integer",
"description": "The field associated with the property.",
"format": "int32"
},
"id": {
"type": "string",
"description": "The id of the property."
}
}
},
"An input mapping for a drill down to a dashboard.": {
"required": [
"dashboardInputId"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"parentDrillDownChartInputName": {
"type": "string",
"description": "The name of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT."
},
"parentOutput": {
"enum": [
"X_VALUE",
"Y_VALUE",
"R_VALUE",
"SERIES_NAME",
"TEXT_LABEL",
"TEXT_VALUE",
"CELL_VALUE",
"COLUMN_HEADER",
"NAMED_COLUMN_VALUE"
],
"type": "string",
"description": "The type of parent output to send as the value for the mapping, set only when inputType is PARENT_OUTPUT."
},
"dashboardInputName": {
"type": "string",
"description": "The name of the target dashboard input."
},
"id": {
"type": "string",
"description": "The ID of the item."
},
"dashboardInputValue": {
"type": "string",
"description": "The default value of the target dashboard input."
},
"parentDrillDownChartInputId": {
"type": "string",
"description": "The ID of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT."
},
"dashboardInputId": {
"type": "string",
"description": "The ID of the target dashboard input."
},
"tableColumnName": {
"type": "string",
"description": "The name of the table column to send as the value for the mapping, set only when inputType is PARENT_OUTPUT and parentOutput is NAMED_COLUMN_VALUE."
},
"inputDashboardInputName": {
"type": "string",
"description": "The name of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT."
},
"inputType": {
"enum": [
"DASHBOARD_INPUT",
"PARENT_INPUT",
"PARENT_OUTPUT",
"DEFAULT_VALUE"
],
"type": "string",
"description": "The type of input given to the target dashboard input."
},
"inputDashboardInputId": {
"type": "string",
"description": "The ID of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT"
},
"drillDownId": {
"type": "string",
"description": "The ID of the drill down that owns this input."
}
}
},
"An input to a dashboard.": {
"discriminator": "_class",
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"value": {
"type": "object"
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
},
"OperationDTO": {
"type": "object",
"properties": {
"returnObjects": {
"items": {
"$ref": "#/definitions/ParameterDTO"
},
"type": "array"
},
"name": {
"type": "string"
},
"parameters": {
"xml": {
"name": "parameter"
},
"items": {
"$ref": "#/definitions/ParameterDTO"
},
"type": "array"
}
}
},
"Configuration informaton to send a value through webservices.": {
"type": "object",
"properties": {
"momentInTime": {
"default": false,
"type": "boolean",
"description": "Flag if data type is DATE and is a moment in time. Note that this field defaults to true for any data type."
},
"booleanArrayValue": {
"items": {
"type": "boolean"
},
"type": "array",
"description": "The boolean value array to send in."
},
"numericValue": {
"type": "number",
"description": "The numeric value to send in.",
"format": "double"
},
"name": {
"type": "string",
"description": "The name of the value to send in."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DAY",
"NUMBER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"NUMBER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type of the value to send in."
},
"value": {
"type": "object"
},
"dateValue": {
"type": "integer",
"description": "The date value to send in.",
"format": "int64"
},
"stringArrayValue": {
"items": {
"type": "string"
},
"type": "array",
"description": "The string value array to send in."
},
"stringValue": {
"type": "string",
"description": "The string value to send in."
},
"numericArrayValue": {
"items": {
"type": "number",
"format": "double"
},
"type": "array",
"description": "The double value array to send in."
},
"booleanValue": {
"default": false,
"type": "boolean",
"description": "The boolean value to send in."
},
"dateArrayValue": {
"items": {
"type": "integer",
"format": "int64"
},
"type": "array",
"description": "The date value array to send in."
}
}
},
"DocumentTypeProcessModel": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "string"
},
"processModelId": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"processModel": {
"$ref": "#/definitions/ProcessModel"
},
"packageItemName": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"JobCompletionDTO": {
"type": "object",
"properties": {
"successful": {
"default": false,
"type": "boolean"
},
"errorMessage": {
"type": "string"
}
}
},
"FormInstance": {
"required": [
"completed",
"createdDate",
"isLocked",
"lastModifiedBy",
"lastModifiedDate",
"showInSavedList",
"submitted"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formActionIds": {
"items": {
"type": "string"
},
"type": "array"
},
"form": {
"$ref": "#/definitions/Form"
},
"creator": {
"$ref": "#/definitions/User"
},
"showInSavedList": {
"default": false,
"type": "boolean"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"completed": {
"default": false,
"type": "boolean"
},
"submitted": {
"default": false,
"type": "boolean"
},
"lastModifiedBy": {
"type": "string"
},
"isLocked": {
"default": false,
"type": "boolean"
},
"formDocuments": {
"items": {
"$ref": "#/definitions/FormDocument"
},
"type": "array"
},
"submittedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"completedDate": {
"type": "string",
"format": "date-time"
},
"formInstanceData": {
"items": {
"$ref": "#/definitions/FormInstanceData"
},
"type": "array"
},
"savedDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"currentStep": {
"$ref": "#/definitions/FormStep"
},
"lockOwner": {
"type": "string"
}
}
},
"DatabaseColumnDTO": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"nullable": {
"default": false,
"type": "boolean"
},
"dataType": {
"type": "string"
},
"autoIncrement": {
"default": false,
"type": "boolean"
},
"columnSize": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "integer",
"format": "int32"
},
"primaryKey": {
"default": false,
"type": "boolean"
}
}
},
"Permission": {
"required": [
"description",
"name",
"permissionClassification",
"permissionKey",
"permissionType"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"permissionClassification": {
"$ref": "#/definitions/PermissionClassification"
},
"permissionKey": {
"type": "string"
},
"permissionType": {
"enum": [
"FEATURE_RIGHT",
"GROUP_ADMINISTRATION",
"SYSTEM_ACCESS"
],
"type": "string"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"An object used to render a dashboard.": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the dashboard is currently in a valid state."
},
"dateModified": {
"type": "string",
"description": "The date and time when the dashboard was last modified.",
"format": "date-time"
},
"content": {
"items": {
"$ref": "#/definitions/RenderDashboardContentDTO"
},
"type": "array",
"description": "The charts that reside on the dashboard."
},
"backgroundColor": {
"type": "string",
"description": "The background color of the dashboard."
},
"margin": {
"type": "integer",
"description": "The margin between charts on the dashboard.",
"format": "int32"
},
"id": {
"type": "string",
"description": "The ID of the dashboard."
}
}
},
"GroupMember": {
"required": [
"group",
"user"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"group": {
"$ref": "#/definitions/Group"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"user": {
"$ref": "#/definitions/User"
},
"groupAdmin": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
}
}
},
"A single validation error or warning.": {
"type": "object",
"properties": {
"objectName": {
"type": "string",
"description": "The name of the object to which the error pertains."
},
"errorMessage": {
"type": "string",
"description": "The detailed error message."
},
"errorCode": {
"type": "string",
"description": "A generic error code."
},
"fieldName": {
"type": "string",
"description": "The name of the filed to which the error pertains."
},
"errorInfo": {
"type": "string",
"description": "Additional error information."
},
"localeErrorCode": {
"type": "string",
"description": "The DocFinity locale error code."
}
}
},
"The configuration for a range color on a radial axis for a chart.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of the color.",
"format": "int32"
},
"color": {
"type": "string",
"description": "The color to use."
},
"width": {
"type": "integer",
"description": "The width of this color.",
"format": "int32"
}
}
},
"MacroFunctionDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"argumentCount": {
"type": "integer",
"format": "int32"
}
}
},
"SearchResultColumn": {
"required": [
"attributeName",
"attributeType",
"ordinal",
"search"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"attribute": {
"type": "object"
},
"attributeName": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"searchResultLinkedMetadata": {
"$ref": "#/definitions/SearchResultLinkedMetadata"
},
"attributeId": {
"type": "string"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"Validator": {
"required": [
"errorLevel",
"name"
],
"type": "object",
"properties": {
"parameterNames": {
"items": {
"type": "string"
},
"type": "array"
},
"validatorPluginDTO": {
"$ref": "#/definitions/ValidatorPluginDTO"
},
"description": {
"type": "string"
},
"errorLevel": {
"enum": [
"ERROR",
"WARNING"
],
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"validatorType": {
"type": "string"
},
"properties": {
"items": {
"$ref": "#/definitions/ValidatorProperty"
},
"type": "array"
},
"name": {
"type": "string"
}
}
},
"DTO object for a FormControl.": {
"type": "object",
"properties": {
"controlSteps": {
"items": {
"$ref": "#/definitions/FormControlStepDTO"
},
"type": "array",
"description": "Gets the controlSteps attribute of the FormControlDTO object."
},
"inputFlag": {
"default": false,
"type": "boolean",
"description": "Gets the flag indicating if this form control supports user input."
},
"defaultData": {
"description": "Gets the defaultData attribute of the FormControlDTO object.",
"$ref": "#/definitions/DatasourceResult"
},
"name": {
"type": "string",
"description": "Gets the name attribute of the FormControlDTO object."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "Gets the dataType attribute of the FormControlDTO object."
},
"deleted": {
"default": false,
"type": "boolean",
"description": "Gets the deleted attribute of the FormControlDTO object."
},
"type": {
"type": "string",
"description": "Gets the type attribute of the FormControlDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the FormControlDTO object."
}
}
},
"SearchDocIndexingMetadataDTO": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"metadataId": {
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"valueType": {
"enum": [
"VARIABLE",
"STATIC",
"DATASOURCE"
],
"type": "string"
}
}
},
"A paged collection of search results for some entity.": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"xml": {
"name": "result"
},
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array",
"description": "The current page of results."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"The representation of the form data to associated to the search.": {
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean",
"description": "The deleted attribute of the search form data."
},
"searchId": {
"type": "string",
"description": "The unique identifier of the search."
},
"id": {
"type": "string",
"description": "The unique identifier of the form data."
},
"value": {
"type": "string",
"description": "The value of the piece of form data."
},
"formControlName": {
"type": "string",
"description": "The name of the form control."
}
}
},
"The HSM action plugin dto.": {
"type": "object",
"properties": {
"iconName": {
"type": "string",
"description": "The icon associated with the plugin."
},
"searchable": {
"default": false,
"type": "boolean",
"description": "Flag to indicate if preview is supported by the plugin using sorts and criteria."
},
"processSupport": {
"enum": [
"NOT_SUPPORTED",
"ZERO_ITEM_PROCESS",
"SINGLE_ITEM_PROCESS"
],
"type": "string",
"description": "Get the process support information."
},
"label": {
"type": "string",
"description": "The label of the plugin."
},
"supportsKeys": {
"default": false,
"type": "boolean",
"description": "Boolean flag to indicate if the plugin supports key."
},
"parameters": {
"items": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": "array",
"description": "Get the parameters used by the plugin."
},
"type": {
"type": "string",
"description": "The type of the plugin."
}
}
},
"StorageType": {
"type": "object",
"properties": {
"pixelType": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"compression": {
"type": "string"
}
}
},
"TaskCompletionDTO": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string"
},
"remainingTasks": {
"items": {
"$ref": "#/definitions/DocfinityTaskDTO"
},
"type": "array"
}
}
},
"A user who is assigned to a specific order in a role.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of the actor in the role, controls distribution order.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this actor should be deleted from this role."
},
"firstName": {
"type": "string",
"description": "The first name of the actor."
},
"roleId": {
"type": "string",
"description": "The ID of the role that holds this Actor."
},
"actor": {
"type": "string",
"description": "The user name of the actor (not the User ID)."
},
"lastName": {
"type": "string",
"description": "The last name of the actor."
},
"id": {
"type": "string",
"description": "The ID of the actor (not a User ID)."
}
}
},
"A date prompt.": {
"allOf": [
{
"$ref": "#/definitions/A user prompt input that allows a datasource and is required."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"macroValue": {
"type": "string"
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"defaultDate": {
"type": "string",
"description": "The default static date, used when defaultValueType is STATIC.",
"format": "date-time"
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"defaultValueType": {
"enum": [
"STATIC",
"MACRO",
"DATASOURCE",
"FIRST",
"SPECIFIC",
"PROMPT"
],
"type": "string",
"description": "The default value type."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"label": {
"type": "string",
"description": "The prompt label."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"strDefaultValue": {
"type": "string"
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"required": {
"default": false,
"type": "boolean",
"description": "Whether the input is required."
},
"value": {
"type": "object"
},
"defaultMacro": {
"type": "string",
"description": "The default macro, used when defaultValueType is MACRO."
},
"promptType": {
"enum": [
"SWITCH",
"DATE",
"TEXT",
"DROP_DOWN_LIST"
],
"type": "string",
"description": "The prompt type."
}
}
}
]
},
"Representation of the search to group association.": {
"type": "object",
"properties": {
"groupName": {
"type": "string",
"description": "The name of the associated group."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the association should be deleted."
},
"groupId": {
"type": "string",
"description": "The ID of the associated group."
},
"id": {
"type": "string",
"description": "The ID used to uniquely identify the search to group association."
}
}
},
"UserDTO": {
"type": "object",
"properties": {
"userName": {
"type": "string"
},
"emailUser": {
"default": false,
"type": "boolean"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"externallyManaged": {
"default": false,
"type": "boolean"
},
"userStatus": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string"
},
"modifiedTimestamp": {
"type": "integer",
"format": "int64"
},
"externalReference": {
"type": "string"
},
"userType": {
"enum": [
"INTERNAL",
"EXTERNAL",
"SYSTEM"
],
"type": "string"
},
"passwordExpirationDays": {
"type": "integer",
"format": "int32"
},
"emailAddress": {
"type": "string"
},
"passwordForceChange": {
"default": false,
"type": "boolean"
},
"passwordType": {
"enum": [
"GENERATED",
"MANUAL"
],
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"password": {
"type": "string"
},
"id": {
"type": "string"
},
"externalProviderId": {
"type": "integer",
"format": "int64"
},
"associationLevel": {
"enum": [
"ALL",
"PARTIAL",
"NONE"
],
"type": "string"
}
}
},
"CheckOutJobResultDTO": {
"type": "object",
"properties": {
"successful": {
"default": false,
"type": "boolean"
},
"errorCode": {
"type": "string"
},
"autoCompleteJob": {
"default": false,
"type": "boolean"
},
"errorMessage": {
"type": "string"
}
}
},
"The representation of a Chart object.": {
"discriminator": "_class",
"required": [
"name"
],
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
},
"A DTO for complex data used in the macro builder for hidden, required, and disabled properties.": {
"type": "object",
"properties": {
"andOr": {
"type": "string",
"description": "Gets the andOr attribute of the FormControlConfigDTO object."
},
"secondOperand": {
"type": "string",
"description": "Gets the secondOperand attribute of the FormControlConfigDTO object."
},
"deleted": {
"default": false,
"type": "boolean",
"description": "Gets the deleted attribute of the FormControlConfigDTO object."
},
"firstOperand": {
"type": "string",
"description": "Gets the firstOperand attribute of the FormControlConfigDTO object."
},
"secondOperandType": {
"type": "string",
"description": "Gets the secondOperandType attribute of the FormControlConfigDTO object."
},
"firstOperandType": {
"type": "string",
"description": "Gets the firstOperandType attribute of the FormControlConfigDTO object."
},
"macroName": {
"type": "string",
"description": "Gets the macroName attribute of the FormControlConfigDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the FormControlConfigDTO object."
}
}
},
"SearchStoredProcedureParameter": {
"required": [
"mode",
"name",
"searchStoredProcedure",
"type"
],
"type": "object",
"properties": {
"ordinal": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"mode": {
"enum": [
"IN",
"OUT",
"INOUT",
"RESULT",
"RETURN",
"UNKNOWN"
],
"type": "string"
},
"type": {
"enum": [
"INTEGER",
"NUMBER",
"SMALLINT",
"BIGINT",
"TINYINT",
"BOOLEAN",
"BIT",
"DATE",
"TIME",
"TIMESTAMP",
"DOUBLE",
"FLOAT",
"DECIMAL",
"NUMERIC",
"REAL",
"VARCHAR",
"LONGVARCHAR",
"CHAR",
"BLOB",
"CLOB",
"NCLOB",
"NVARCHAR",
"NCHAR",
"LONGNVARCHAR",
"SQLXML",
"STRING",
"ARRAY",
"BINARY",
"DATALINK",
"DISTINCT",
"JAVA_OBJECT",
"NULL",
"REF",
"STRUCT",
"VARBINARY",
"LONGVARBINARY",
"ROWID",
"UNKNOWN"
],
"type": "string"
},
"id": {
"type": "string"
},
"searchStoredProcedure": {
"$ref": "#/definitions/SearchStoredProcedure"
}
}
},
"An object containing the configuration for a chart legend.": {
"type": "object",
"properties": {
"visible": {
"default": false,
"type": "boolean",
"description": "Whether the legend is visible."
},
"position": {
"type": "string",
"description": "The legend's position."
}
}
},
"An argument to be sent to a datasource.": {
"type": "object",
"properties": {
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type of the property."
},
"key": {
"type": "string"
},
"dataValue": {
"type": "object"
},
"name": {
"type": "string",
"description": "The name of the property."
},
"value": {
"type": "string",
"description": "The value of the property in string form."
}
}
},
"FormInstanceDataDTO": {
"type": "object",
"properties": {
"formInstanceId": {
"type": "string"
},
"booleanValue": {
"default": false,
"type": "boolean"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string"
},
"value": {
"type": "object"
},
"formControlName": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"arrayType": {
"default": false,
"type": "boolean"
},
"dateValue": {
"type": "integer",
"format": "int64"
},
"integerValue": {
"type": "integer",
"format": "int32"
},
"decimalValue": {
"type": "number",
"format": "double"
},
"stringValue": {
"type": "string"
},
"formName": {
"type": "string"
},
"id": {
"type": "string"
},
"formControlId": {
"type": "string"
}
}
},
"A dashboard used to display charts to a user.": {
"required": [
"backgroundColor",
"categoryId",
"name",
"status"
],
"type": "object",
"properties": {
"status": {
"enum": [
"STANDARD"
],
"type": "string",
"description": "The status of the dashboard, should always be STANDARD for user dashboards."
},
"name": {
"type": "string",
"description": "The name of the dashboard. Must be unique within its category."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this dashboard for editing."
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors while saving this dashboard."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether this dashboard is currently in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this dashboard for editing."
},
"groupCount": {
"type": "integer",
"description": "The number of groups that are currently assigned access to this dashboard.",
"format": "int64"
},
"id": {
"type": "string",
"description": "The ID of the dashboard."
},
"content": {
"items": {
"$ref": "#/definitions/An instance of a chart on a dashboard at the top level."
},
"type": "array",
"description": "The charts that reside on this dashboard."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether this dashboard is currently locked for editing."
},
"dashboardInputs": {
"items": {
"$ref": "#/definitions/An input to a dashboard."
},
"type": "array",
"description": "The inputs provided to the dashboard, in the form of hidden inputs or user prompts."
},
"backgroundColor": {
"type": "string",
"description": "The background color of the dashboard."
},
"isUserAssigned": {
"default": false,
"type": "boolean",
"description": "Whether the current user is assigned group access to this dashboard."
},
"dateModified": {
"type": "string",
"description": "The date and time that this dashboard was last modified.",
"format": "date-time"
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has locked this dashboard for editing."
},
"margin": {
"type": "integer",
"description": "The margin between charts on this dashboard.",
"format": "int32"
},
"categoryId": {
"type": "string",
"description": "The ID of the dashboard category that holds this dashboard."
},
"drillDownCount": {
"type": "integer",
"description": "The number of dashboards that drill down to this dashboard.",
"format": "int64"
},
"categoryName": {
"type": "string",
"description": "The name of the category that holds this dashboard."
}
}
},
"An index importer.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"type": "object",
"properties": {
"directoryPath": {
"type": "string",
"description": "The directory path being monitored by the importer."
},
"importerPluginName": {
"type": "string",
"description": "The plugin to be used by the importer."
},
"get_class": {
"type": "string"
},
"ruleSets": {
"items": {
"$ref": "#/definitions/The rule set associated with the importer."
},
"type": "array",
"description": "The rulesets to be used by the importer."
},
"filePathField": {
"type": "integer",
"description": "The field index that holds file path in the index file.",
"format": "int32"
},
"pollingFrequency": {
"type": "integer",
"description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder.",
"format": "int32"
},
"serial": {
"default": false,
"type": "boolean",
"description": "Flag indicating the files are to be processed serially."
},
"id": {
"type": "string",
"description": "The id of the importer."
},
"preRender": {
"default": false,
"type": "boolean",
"description": "Flag indicating that files imported by the importer will be pre-rendered."
},
"fileFilter": {
"type": "string",
"description": "The file filter to be used by the importer."
},
"delimiter": {
"type": "string",
"description": "The delimiter for the index file."
},
"processType": {
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"type": "string",
"description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX."
},
"pending": {
"default": false,
"type": "boolean",
"description": "Flag indicating that start/stop of importer is pending."
},
"status": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The importer status INTERNAL/EXTERNAL."
},
"calculatedProperties": {
"items": {
"$ref": "#/definitions/The representation of the calculated property associated with the importer."
},
"type": "array",
"description": "The calculated properties to be used by the importer."
},
"description": {
"type": "string",
"description": "The description to be used by the importer."
},
"schedule": {
"description": "The importer schedule.",
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"running": {
"default": false,
"type": "boolean",
"description": "Flag indicating that the importer is running."
},
"importMethod": {
"enum": [
"COPY",
"MOVE",
"IN_PLACE",
"NONE",
"IMPORT_EXTERNAL"
],
"type": "string",
"description": "The import method associated with the index import. MOVE, COPY, IN_PLACE"
},
"pollingUnits": {
"enum": [
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"type": "string",
"description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS."
},
"lastErrorMessage": {
"type": "string",
"description": "The last error message associated with the importer."
},
"properties": {
"items": {
"$ref": "#/definitions/A property used in an importer."
},
"type": "array",
"description": "The properties to be used by the importer."
},
"name": {
"type": "string",
"description": "The name of the importer."
},
"externalRepositoryPluginName": {
"type": "string",
"description": "The repository plugin to be used by the importer."
},
"server": {
"type": "string",
"description": "The server details where the importer will run."
},
"idle": {
"default": false,
"type": "boolean",
"description": "Flag indicating importer is running but not processing."
}
}
}
]
},
"DocumentTypeMetadataDatasource": {
"required": [
"editable"
],
"type": "object",
"properties": {
"editable": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"runDatasource": {
"default": false,
"type": "boolean"
},
"documentTypeMetadata": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"id": {
"type": "string"
},
"datasource": {
"$ref": "#/definitions/Datasource"
}
}
},
"ProcessModelDTO": {
"type": "object",
"properties": {
"xml": {
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"INACTIVE_STILL_RUNNING"
],
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"readOnly": {
"default": false,
"type": "boolean"
},
"dateModified": {
"type": "string",
"format": "date-time"
},
"documentTypeProcessModels": {
"items": {
"$ref": "#/definitions/DocumentTypeProcessModelDTO"
},
"type": "array"
},
"isLocked": {
"default": false,
"type": "boolean"
},
"version": {
"type": "integer",
"format": "int32"
},
"processModelPackageItems": {
"items": {
"$ref": "#/definitions/ProcessModelPackageItemDTO"
},
"type": "array"
},
"id": {
"type": "string"
},
"lockOwner": {
"type": "string"
}
}
},
"DataStore data used to configure datastores for the system.": {
"required": [
"databaseConnectionId",
"name",
"tableName"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description of the datastore."
},
"tableName": {
"type": "string",
"description": "The database table name to be used by the datastore."
},
"name": {
"type": "string",
"description": "The name of the datastore."
},
"databaseConnectionId": {
"type": "string",
"description": "The id of the database connection to be used by the datastore."
},
"id": {
"type": "string",
"description": "The ID of the datastore configuration data."
},
"columns": {
"items": {
"$ref": "#/definitions/Database column information used by datastores."
},
"type": "array",
"description": "The database table columns to be used by the datastore."
},
"schema": {
"type": "string",
"description": "The database schema name to be used by the datastore."
}
}
},
"DateFormatsDTO": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"dateTime": {
"type": "string"
},
"time": {
"type": "string"
}
}
},
"An input mapping for a drill down to a chart.": {
"required": [
"chartVariableId"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"parentDrillDownChartInputName": {
"type": "string",
"description": "The name of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT."
},
"chartVariableId": {
"type": "string",
"description": "The ID of the target chart variable."
},
"id": {
"type": "string",
"description": "The ID."
},
"parentOutput": {
"enum": [
"X_VALUE",
"Y_VALUE",
"R_VALUE",
"SERIES_NAME",
"TEXT_LABEL",
"TEXT_VALUE",
"CELL_VALUE",
"COLUMN_HEADER",
"NAMED_COLUMN_VALUE"
],
"type": "string",
"description": "The type of parent output to send as the value for the mapping, set only when inputType is PARENT_OUTPUT."
},
"chartVariableName": {
"type": "string",
"description": "The name of the target chart variable."
},
"parentDrillDownChartInputId": {
"type": "string",
"description": "The ID of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT."
},
"tableColumnName": {
"type": "string",
"description": "The name of the table column to send as the value for the mapping, set only when inputType is PARENT_OUTPUT and parentOutput is NAMED_COLUMN_VALUE."
},
"inputDashboardInputName": {
"type": "string",
"description": "The name of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT."
},
"inputType": {
"enum": [
"DASHBOARD_INPUT",
"PARENT_INPUT",
"PARENT_OUTPUT"
],
"type": "string",
"description": "The type of input given to the target chart variable."
},
"inputDashboardInputId": {
"type": "string",
"description": "The ID of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT."
},
"drillDownId": {
"type": "string",
"description": "The ID of the DrillDown that owns this item."
}
}
},
"DispositionConditionDTO": {
"type": "object",
"properties": {
"target": {
"enum": [
"DATE_METADATA",
"DOCUMENT_CREATED_DATE",
"DOCUMENT_INDEXED_DATE",
"DOCUMENT_LAST_VIEWED_DATE",
"FILE_CREATED_DATE"
],
"type": "string"
},
"metadataId": {
"type": "string"
},
"period": {
"type": "integer",
"format": "int32"
},
"metadataName": {
"type": "string"
},
"timeUnit": {
"enum": [
"DAYS",
"WEEKS",
"MONTHS",
"YEARS"
],
"type": "string"
},
"id": {
"type": "string"
}
}
},
"Search": {
"required": [
"name",
"searchType"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"documentsExist": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"searchParameters": {
"items": {
"$ref": "#/definitions/SearchParameter"
},
"type": "array"
},
"searchType": {
"enum": [
"TEMPLATE",
"CATEGORY",
"CHECKLIST",
"STORED_PROCEDURE",
"HSM"
],
"type": "string"
},
"allDocumentTypeIds": {
"items": {
"type": "string"
},
"type": "array"
},
"searchDocIndexing": {
"$ref": "#/definitions/SearchDocIndexing"
},
"searchStoredProcedure": {
"$ref": "#/definitions/SearchStoredProcedure"
},
"formDesignName": {
"type": "string"
},
"searchSubSearches": {
"items": {
"$ref": "#/definitions/SearchChecklistSubSearch"
},
"type": "array"
},
"description": {
"type": "string"
},
"allCategories": {
"items": {
"$ref": "#/definitions/Category"
},
"type": "array"
},
"searchFormData": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/SearchFormData"
},
"type": "array"
},
"searchSortOrders": {
"items": {
"$ref": "#/definitions/SearchSortOrder"
},
"type": "array"
},
"searchPrompts": {
"items": {
"$ref": "#/definitions/SearchPrompt"
},
"type": "array"
},
"allDocumentTypes": {
"items": {
"$ref": "#/definitions/DocumentType"
},
"type": "array"
},
"searchResultColumns": {
"items": {
"$ref": "#/definitions/SearchResultColumn"
},
"type": "array"
},
"searchGroups": {
"items": {
"$ref": "#/definitions/SearchGroup"
},
"type": "array"
},
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formEditable": {
"default": false,
"type": "boolean"
},
"searchTreeFilter": {
"items": {
"$ref": "#/definitions/SearchTreeFilter"
},
"type": "array"
}
}
},
"OutputStream": {
"type": "object"
},
"SearchSortOrderCustom": {
"required": [
"ordinal",
"searchSortOrder",
"value"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
},
"searchSortOrder": {
"$ref": "#/definitions/SearchSortOrder"
}
}
},
"WebserviceDTO": {
"type": "object",
"properties": {
"services": {
"items": {
"$ref": "#/definitions/ServiceInfoDTO"
},
"type": "array"
},
"name": {
"type": "string"
},
"wsdlUrl": {
"type": "string"
}
}
},
"Data value used to represent a generic key value pair.": {
"type": "object",
"properties": {
"comparableValue": {
"$ref": "#/definitions/ComparableObject"
},
"key": {
"type": "string",
"description": "The key of the data value."
},
"value": {
"type": "object",
"description": "The value of the data value."
}
}
},
"The HSM policys scheduled time.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of the HSM scheduled time.",
"format": "int32"
},
"deleted": {
"default": false,
"type": "boolean",
"description": "Get the deleted flag of the HSM scheduled time."
},
"weekdayOccurrence": {
"type": "integer",
"description": "The week day occurrence of the HSM scheduled time.",
"format": "int32"
},
"weekday": {
"type": "integer",
"description": "The week day the HSM scheduled time.",
"format": "int32"
},
"startTime": {
"type": "string",
"description": "The start time of the HSM scheduled time."
},
"duration": {
"type": "integer",
"description": "The duration of the HSM scheduled time.",
"format": "int32"
},
"id": {
"type": "string",
"description": "The id of the HSM scheduled time."
}
}
},
"The definition of a data source parameters.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The deleted flag of the datasource parameter."
},
"datasourceName": {
"type": "string",
"description": "The datasource name of the datasource parameter."
},
"name": {
"type": "string",
"description": "The name of the datasource parameter."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type of the datasource parameter."
},
"value": {
"type": "string",
"description": "The value of the datasource parameter."
},
"source": {
"enum": [
"STATIC",
"MACRO",
"VARIABLE"
],
"type": "string",
"description": "The source of the datasource parameter."
},
"datasourceId": {
"type": "string",
"description": "The datasource id of the datasource parameter."
},
"id": {
"type": "string",
"description": "The id of the datasource parameter."
}
}
},
"SearchPromptDatasource": {
"required": [
"datasource",
"searchPrompt"
],
"type": "object",
"properties": {
"searchPrompt": {
"$ref": "#/definitions/SearchPrompt"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"searchPromptDatasourceParameters": {
"items": {
"$ref": "#/definitions/SearchPromptDatasourceParam"
},
"type": "array"
},
"id": {
"type": "string"
},
"datasource": {
"$ref": "#/definitions/Datasource"
}
}
},
"A line chart.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"DataFlavor": {
"type": "object",
"properties": {
"mimeType": {
"type": "string"
},
"primaryType": {
"type": "string"
},
"representationClassRemote": {
"default": false,
"type": "boolean"
},
"representationClassInputStream": {
"default": false,
"type": "boolean"
},
"subType": {
"type": "string"
},
"representationClassReader": {
"default": false,
"type": "boolean"
},
"flavorTextType": {
"default": false,
"type": "boolean"
},
"defaultRepresentationClassAsString": {
"type": "string"
},
"representationClassCharBuffer": {
"default": false,
"type": "boolean"
},
"representationClassSerializable": {
"default": false,
"type": "boolean"
},
"flavorJavaFileListType": {
"default": false,
"type": "boolean"
},
"humanPresentableName": {
"type": "string"
},
"mimeTypeSerializedObject": {
"default": false,
"type": "boolean"
},
"flavorSerializedObjectType": {
"default": false,
"type": "boolean"
},
"representationClassByteBuffer": {
"default": false,
"type": "boolean"
},
"flavorRemoteObjectType": {
"default": false,
"type": "boolean"
}
}
},
"The representation of the storage type entity used for scanning configuration.": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the storage type.",
"format": "int64"
},
"pixelType": {
"type": "integer",
"description": "The pixel type attribute of the storage type.",
"format": "int32"
},
"compression": {
"type": "string",
"description": "The compression attribute of the storage type."
},
"description": {
"type": "string",
"description": "The description attribute of the storage type."
}
}
},
"Detached object representation of persisted LDAP synchronization errors.": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Detailed error message. May be truncated."
},
"entityType": {
"enum": [
"USER",
"GROUP",
"SYSTEM"
],
"type": "string",
"description": "Detailed error message. May be truncated."
},
"fieldName": {
"type": "string",
"description": "Name of field. Context sensitive."
},
"objectName": {
"type": "string",
"description": "Name of object. Context sensitive."
}
}
},
"Object representing an item on the clipboard for a user.": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name for the document."
},
"userId": {
"type": "string",
"description": "The user ID."
},
"id": {
"type": "string",
"description": "The ID of this item."
},
"documentId": {
"type": "string",
"description": "The document ID."
}
}
},
"Overlay": {
"required": [
"name",
"path"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"nameChanged": {
"default": false,
"type": "boolean"
},
"path": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"The batch group associated with the rule set.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag to indicate the rule set batch group has been deleted."
},
"name": {
"type": "string",
"description": "The name of the group, read-only."
},
"batchGroupName": {
"type": "string",
"description": "The group name associated with the ruleset batch group."
},
"groupId": {
"type": "string",
"description": "The group id associated with the rule set batch group."
},
"ruleSetId": {
"type": "string",
"description": "The id associated with the rule set."
},
"id": {
"type": "string",
"description": "The id associated with the ruleset batch group."
}
}
},
"LicensePoolDTO": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"description": {
"type": "string"
},
"firstName": {
"type": "string"
},
"isGroupPool": {
"default": false,
"type": "boolean"
},
"lastName": {
"type": "string"
},
"userId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"licensePoolUserId": {
"type": "string"
},
"allocatedLicenses": {
"type": "integer",
"format": "int32"
},
"licensePoolGroupId": {
"type": "string"
},
"numberOfUsersInGroup": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"FormControlConfig": {
"required": [
"propertyName"
],
"type": "object",
"properties": {
"andOr": {
"type": "string"
},
"secondOperand": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"formControlStep": {
"$ref": "#/definitions/FormControlStep"
},
"propertyName": {
"type": "string"
},
"firstOperand": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"secondOperandType": {
"type": "string"
},
"firstOperandType": {
"type": "string"
},
"macroName": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"A category used to group together related dashboards.": {
"required": [
"name"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A brief description of the category."
},
"id": {
"type": "string",
"description": "The ID of the category."
},
"name": {
"type": "string",
"description": "The name of the category. Must be unique."
}
}
},
"FormGroup": {
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"$ref": "#/definitions/Group"
},
"id": {
"type": "string"
},
"groupId": {
"type": "string"
},
"formName": {
"type": "string"
}
}
},
"An object representing the validator type-specific properties.": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "An object representing the display name of the validator property."
},
"name": {
"type": "string",
"description": "An object representing the name of the validator property."
},
"value": {
"type": "string",
"description": "An object representing the value of the validator property."
},
"displayValue": {
"type": "string",
"description": "An object representing the display value of the validator property."
},
"validatorId": {
"type": "string",
"description": "An object representing the ID of the validator associated to this property."
},
"id": {
"type": "string",
"description": "An object representing the ID of the validator property."
}
}
},
"DocumentVariable": {
"required": [
"name",
"type",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"type": "string"
},
"document": {
"$ref": "#/definitions/Document"
},
"type": {
"enum": [
"HSM"
],
"type": "string"
},
"id": {
"type": "string"
}
}
},
"GroupFeatureRight": {
"required": [
"featureRight",
"group"
],
"type": "object",
"properties": {
"featureRight": {
"$ref": "#/definitions/FeatureRight"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"group": {
"$ref": "#/definitions/Group"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"authority": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"A feature right for the system.": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The feature right name."
},
"classificationId": {
"type": "string",
"description": "The ID of the classification group for this feature right."
},
"key": {
"type": "string",
"description": "The feature right key (unique)."
},
"classificationName": {
"type": "string",
"description": "The classification name."
},
"id": {
"type": "string",
"description": "The feature right ID."
},
"description": {
"type": "string",
"description": "The feature right description."
}
}
},
"DeviceGroup": {
"required": [
"group",
"printFaxDevice"
],
"type": "object",
"properties": {
"printFaxDevice": {
"$ref": "#/definitions/PrintFaxDevice"
},
"group": {
"$ref": "#/definitions/Group"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"An index importer property.": {
"allOf": [
{
"$ref": "#/definitions/A property used in an importer."
},
{
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal associated with the property.",
"format": "int32"
},
"trim": {
"default": false,
"type": "boolean",
"description": "Flag indicating the property value needs to be trimmed."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag indicating the property is marked for deletion."
},
"name": {
"type": "string",
"description": "The name associated with the property."
},
"textCase": {
"type": "string",
"description": "The text case associated with the property."
},
"dataType": {
"type": "string",
"description": "The data type associated with the property."
},
"defaultValue": {
"type": "string",
"description": "The default value of the property."
},
"format": {
"type": "string",
"description": "The date format associated with the property."
},
"field": {
"type": "integer",
"description": "The field associated with the property.",
"format": "int32"
},
"id": {
"type": "string",
"description": "The id of the property."
}
}
}
]
},
"A series color for a chart.": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The series color."
},
"name": {
"type": "string",
"description": "The series name."
}
}
},
"An object that defines the layout of a chart on a dashboard.": {
"type": "object",
"properties": {
"width": {
"type": "integer",
"description": "The width in percentage.",
"format": "int32"
},
"top": {
"type": "integer",
"description": "The top position in percentage.",
"format": "int32"
},
"height": {
"type": "integer",
"description": "The height in percentage.",
"format": "int32"
},
"left": {
"type": "integer",
"description": "The left position in percentage.",
"format": "int32"
}
}
},
"DTO that contains information about a member of a shift.": {
"type": "object",
"properties": {
"userName": {
"type": "string",
"description": "Gets the userName attribute of the ShiftMemberDTO object."
},
"lastName": {
"type": "string",
"description": "Gets the lastName attribute of the ShiftMemberDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the ShiftMemberDTO object."
},
"firstName": {
"type": "string",
"description": "Gets the firstName attribute of the ShiftMemberDTO object."
}
}
},
"DocumentErrorResultDTO": {
"type": "object",
"properties": {
"errorCode": {
"enum": [
"INSUFFICIENT_PERMISSIONS",
"DOCUMENT_IN_BUSINESS_PROCESS",
"DOES_NOT_EXIST",
"FILE_NOT_DELETED",
"DOCUMENT_IS_BEING_EDITED",
"REPOSITORY_NOT_WRITABLE",
"FILE_NOT_MARKED_AS_EXTERNAL",
"DOCUMENT_ON_LEGAL_HOLD",
"RUNTIME_EXCEPTION"
],
"type": "string",
"description": "The specific error code associated with this object."
},
"localizedErrorCode": {
"type": "string",
"description": "The localized error message of the object."
},
"errorMessage": {
"type": "string",
"description": "The specific error message of this object."
},
"displayName": {
"type": "string",
"description": "The display name of the document."
},
"documentId": {
"type": "string",
"description": "The ID of the document."
}
}
},
"DispositionCondition": {
"required": [
"period",
"retentionPolicy",
"target",
"timeUnit"
],
"type": "object",
"properties": {
"target": {
"enum": [
"DATE_METADATA",
"DOCUMENT_CREATED_DATE",
"DOCUMENT_INDEXED_DATE",
"DOCUMENT_LAST_VIEWED_DATE",
"FILE_CREATED_DATE"
],
"type": "string"
},
"validateDateMetadata": {
"default": false,
"type": "boolean"
},
"period": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"retentionPolicy": {
"$ref": "#/definitions/RetentionPolicy"
},
"timeUnit": {
"enum": [
"DAYS",
"WEEKS",
"MONTHS",
"YEARS"
],
"type": "string"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"A mixed chart. Not currently implemented.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"labelColumn": {
"description": "The label column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"dataColumns": {
"items": {
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"type": "array",
"description": "The data column definitions."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"seriesColumn": {
"description": "The series column definition.",
"$ref": "#/definitions/A column returned by a datasource that is used in a chart."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"chartType": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"DocumentHierarchyDTO": {
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"hasChildren": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"parentId": {
"type": "string"
},
"type": {
"type": "string"
},
"categoryId": {
"type": "string"
},
"categoryName": {
"type": "string"
}
}
},
"IndexingConfigurationDTO": {
"type": "object",
"properties": {
"setFocus": {
"default": false,
"type": "boolean"
},
"sort": {
"default": false,
"type": "boolean"
},
"documentTypeId": {
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"dependentMetadataIds": {
"items": {
"type": "string"
},
"type": "array"
},
"blindEntry": {
"default": false,
"type": "boolean"
},
"metadataId": {
"type": "string"
},
"validatorIds": {
"items": {
"type": "string"
},
"type": "array"
},
"datasourceId": {
"type": "string"
},
"allowErrorOverride": {
"default": false,
"type": "boolean"
},
"isDatasourceEditable": {
"default": false,
"type": "boolean"
},
"characterCase": {
"enum": [
"NORMAL",
"UPPER",
"LOWER"
],
"type": "string"
},
"retainValue": {
"default": false,
"type": "boolean"
},
"runDatasource": {
"default": false,
"type": "boolean"
}
}
},
"DocumentTypeMetadata": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int64"
},
"oldRequiredValue": {
"default": false,
"type": "boolean"
},
"userViewerSettings": {
"items": {
"$ref": "#/definitions/UserViewerSetting"
},
"type": "array"
},
"required": {
"default": false,
"type": "boolean"
},
"editable": {
"default": false,
"type": "boolean"
},
"documentTypeMetadataDatasource": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataDatasource"
},
"type": "array"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"documentTypeMetadataDependentDependee": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataDependent"
},
"type": "array"
},
"documentTypeMetadataDependentDependor": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataDependent"
},
"type": "array"
},
"documentTypeMetadataIndexings": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataIndexing"
},
"type": "array"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"documentTypeChecklistIndexing": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataChecklist"
},
"type": "array"
},
"oldEditableValue": {
"default": false,
"type": "boolean"
},
"documentTypeMetadataValidators": {
"items": {
"$ref": "#/definitions/DocumentTypeMetadataValidator"
},
"type": "array"
},
"id": {
"type": "string"
},
"isDefault": {
"default": false,
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"DatabaseMetaData": {
"type": "object",
"properties": {
"maxCatalogNameLength": {
"type": "integer",
"format": "int32"
},
"maxColumnsInGroupBy": {
"type": "integer",
"format": "int32"
},
"systemFunctions": {
"type": "string"
},
"databaseMinorVersion": {
"type": "integer",
"format": "int32"
},
"driverVersion": {
"type": "string"
},
"rowIdLifetime": {
"enum": [
"ROWID_UNSUPPORTED",
"ROWID_VALID_OTHER",
"ROWID_VALID_SESSION",
"ROWID_VALID_TRANSACTION",
"ROWID_VALID_FOREVER"
],
"type": "string"
},
"driverMajorVersion": {
"type": "integer",
"format": "int32"
},
"databaseMajorVersion": {
"type": "integer",
"format": "int32"
},
"schemas": {
"$ref": "#/definitions/ResultSet"
},
"typeInfo": {
"$ref": "#/definitions/ResultSet"
},
"databaseProductName": {
"type": "string"
},
"catalogAtStart": {
"default": false,
"type": "boolean"
},
"extraNameCharacters": {
"type": "string"
},
"driverMinorVersion": {
"type": "integer",
"format": "int32"
},
"clientInfoProperties": {
"$ref": "#/definitions/ResultSet"
},
"maxRowSize": {
"type": "integer",
"format": "int32"
},
"maxLogicalLobSize": {
"type": "integer",
"format": "int64"
},
"maxColumnsInOrderBy": {
"type": "integer",
"format": "int32"
},
"maxTableNameLength": {
"type": "integer",
"format": "int32"
},
"maxUserNameLength": {
"type": "integer",
"format": "int32"
},
"maxStatementLength": {
"type": "integer",
"format": "int32"
},
"maxColumnsInSelect": {
"type": "integer",
"format": "int32"
},
"stringFunctions": {
"type": "string"
},
"catalogs": {
"$ref": "#/definitions/ResultSet"
},
"jdbcminorVersion": {
"type": "integer",
"format": "int32"
},
"maxColumnsInIndex": {
"type": "integer",
"format": "int32"
},
"numericFunctions": {
"type": "string"
},
"schemaTerm": {
"type": "string"
},
"jdbcmajorVersion": {
"type": "integer",
"format": "int32"
},
"timeDateFunctions": {
"type": "string"
},
"maxIndexLength": {
"type": "integer",
"format": "int32"
},
"databaseProductVersion": {
"type": "string"
},
"procedureTerm": {
"type": "string"
},
"maxCursorNameLength": {
"type": "integer",
"format": "int32"
},
"readOnly": {
"default": false,
"type": "boolean"
},
"maxCharLiteralLength": {
"type": "integer",
"format": "int32"
},
"catalogSeparator": {
"type": "string"
},
"searchStringEscape": {
"type": "string"
},
"maxStatements": {
"type": "integer",
"format": "int32"
},
"maxColumnsInTable": {
"type": "integer",
"format": "int32"
},
"sqlkeywords": {
"type": "string"
},
"userName": {
"type": "string"
},
"maxSchemaNameLength": {
"type": "integer",
"format": "int32"
},
"maxColumnNameLength": {
"type": "integer",
"format": "int32"
},
"url": {
"type": "string"
},
"maxTablesInSelect": {
"type": "integer",
"format": "int32"
},
"tableTypes": {
"$ref": "#/definitions/ResultSet"
},
"identifierQuoteString": {
"type": "string"
},
"defaultTransactionIsolation": {
"type": "integer",
"format": "int32"
},
"maxBinaryLiteralLength": {
"type": "integer",
"format": "int32"
},
"connection": {
"$ref": "#/definitions/Connection"
},
"driverName": {
"type": "string"
},
"maxProcedureNameLength": {
"type": "integer",
"format": "int32"
},
"maxConnections": {
"type": "integer",
"format": "int32"
},
"resultSetHoldability": {
"type": "integer",
"format": "int32"
},
"sqlstateType": {
"type": "integer",
"format": "int32"
},
"catalogTerm": {
"type": "string"
}
}
},
"ProcessModel": {
"required": [
"auditingEnabled",
"dateModified",
"isLocked",
"name",
"status",
"version",
"versionMapping",
"xml"
],
"type": "object",
"properties": {
"xml": {
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"INACTIVE_STILL_RUNNING"
],
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"dateModified": {
"type": "string",
"format": "date-time"
},
"documentTypeProcessModels": {
"items": {
"$ref": "#/definitions/DocumentTypeProcessModel"
},
"type": "array"
},
"isLocked": {
"default": false,
"type": "boolean"
},
"version": {
"type": "integer",
"format": "int32"
},
"auditingEnabled": {
"default": false,
"type": "boolean"
},
"versionMapping": {
"type": "integer",
"format": "int32"
},
"processModelPackageItems": {
"items": {
"$ref": "#/definitions/ProcessModelPackageItem"
},
"type": "array"
},
"validateItems": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"lockOwner": {
"type": "string"
}
}
},
"MultipartBody": {
"type": "object",
"properties": {
"childAttachments": {
"items": {
"$ref": "#/definitions/Attachment"
},
"type": "array"
},
"rootAttachment": {
"$ref": "#/definitions/Attachment"
},
"allAttachments": {
"items": {
"$ref": "#/definitions/Attachment"
},
"type": "array"
},
"type": {
"$ref": "#/definitions/MediaType"
}
}
},
"SearchPromptDatasourceDTO": {
"type": "object",
"properties": {
"datasourceName": {
"type": "string"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"datasourceId": {
"type": "string"
},
"id": {
"type": "string"
},
"searchPromptDatasourceParameters": {
"items": {
"$ref": "#/definitions/SearchPromptDatasourceParamDTO"
},
"type": "array"
}
}
},
"DataHandler": {
"type": "object",
"properties": {
"preferredCommands": {
"items": {
"$ref": "#/definitions/CommandInfo"
},
"type": "array"
},
"outputStream": {
"$ref": "#/definitions/OutputStream"
},
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"allCommands": {
"items": {
"$ref": "#/definitions/CommandInfo"
},
"type": "array"
},
"inputStream": {
"$ref": "#/definitions/InputStream"
},
"content": {
"type": "object"
},
"dataSource": {
"$ref": "#/definitions/DataSource"
},
"transferDataFlavors": {
"items": {
"$ref": "#/definitions/DataFlavor"
},
"type": "array"
}
}
},
"A pageable object representing the results of a search.": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"results": {
"xml": {
"name": "result"
},
"items": {
"$ref": "#/definitions/The representation of a search."
},
"type": "array",
"description": "The results of the search."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results to return.",
"format": "int32"
},
"startIndex": {
"type": "integer",
"description": "The starting index.",
"format": "int32"
},
"moreDataAvailable": {
"default": false,
"type": "boolean",
"description": "Whether more data is available but not visible given the current paging criteria."
},
"totalPages": {
"type": "integer",
"description": "The total number of pages.",
"format": "int32"
},
"totalAvailable": {
"type": "integer",
"description": "The total number of available results.",
"format": "int32"
}
}
},
"RetentionPolicyDTO": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"dispositionMethod": {
"enum": [
"DELETE",
"PURGE",
"KEEP"
],
"type": "string"
},
"numberOfApprovals": {
"type": "integer",
"format": "int32"
},
"processModelName": {
"type": "string"
},
"convertToPDFA": {
"default": false,
"type": "boolean"
},
"custodians": {
"items": {
"$ref": "#/definitions/RetentionPolicyCustodianDTO"
},
"type": "array"
},
"documentTypes": {
"items": {
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"type": "array"
},
"type": {
"enum": [
"DEFAULT",
"USER"
],
"type": "string"
},
"id": {
"type": "string"
},
"condition": {
"$ref": "#/definitions/DispositionConditionDTO"
},
"name": {
"type": "string"
}
}
},
"Role": {
"required": [
"roleName"
],
"type": "object",
"properties": {
"validateOrdinals": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"originalName": {
"type": "string"
},
"validateActors": {
"default": false,
"type": "boolean"
},
"actors": {
"items": {
"$ref": "#/definitions/Actor"
},
"type": "array"
},
"nameChanged": {
"default": false,
"type": "boolean"
},
"roleName": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"Document": {
"type": "object",
"properties": {
"entryMethod": {
"enum": [
"PRINT_TO",
"SEND_TO",
"SCAN_TO",
"IMPORT",
"SCAN",
"BPM",
"FILE_UPLOAD",
"OFFICE",
"FORM",
"POINTER",
"SAVE_SEARCH",
"EDITING",
"UNKNOWN"
],
"type": "string"
},
"createdByUser": {
"$ref": "#/definitions/User"
},
"creator": {
"type": "string"
},
"redacted": {
"default": false,
"type": "boolean"
},
"indexedBy": {
"type": "string"
},
"formDocuments": {
"items": {
"$ref": "#/definitions/FormDocument"
},
"type": "array"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"diaryCount": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"dateDeleted": {
"type": "string",
"format": "date-time"
},
"validateRetentionPolicyMetadata": {
"default": false,
"type": "boolean"
},
"retentionPolicyOverrideDate": {
"type": "string",
"format": "date-time"
},
"onLegalHold": {
"default": false,
"type": "boolean"
},
"indexed": {
"default": false,
"type": "boolean"
},
"retentionPolicyOverridden": {
"default": false,
"type": "boolean"
},
"queuedForDisposition": {
"default": false,
"type": "boolean"
},
"checklistDocument": {
"default": false,
"type": "boolean"
},
"diaries": {
"items": {
"$ref": "#/definitions/Diary"
},
"type": "array"
},
"deleted": {
"default": false,
"type": "boolean"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"indexedDate": {
"type": "string",
"format": "date-time"
},
"retentionPolicy": {
"$ref": "#/definitions/RetentionPolicy"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastViewedDate": {
"type": "string",
"format": "date-time"
},
"retentionPolicyOverrideUser": {
"$ref": "#/definitions/User"
},
"reindexDocumentTypeChanged": {
"default": false,
"type": "boolean"
},
"displayName": {
"type": "string"
},
"legalHolds": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/LegalHold"
},
"type": "array"
},
"deletedByUser": {
"$ref": "#/definitions/User"
},
"dispositionQueueItems": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DispositionQueueItem"
},
"type": "array"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentVariables": {
"items": {
"$ref": "#/definitions/DocumentVariable"
},
"type": "array"
},
"fileStore": {
"$ref": "#/definitions/FileStore"
},
"newlyIndexed": {
"default": false,
"type": "boolean"
},
"deletedBy": {
"type": "string"
},
"importUniquenessHash": {
"type": "string"
}
}
},
"Configuration data for job view filter based on groups.": {
"type": "object",
"properties": {
"groupName": {
"type": "string",
"description": "The group name for the ViewQueueGroup object."
},
"viewId": {
"type": "string",
"description": "The view id for the ViewQueueGroup object."
},
"id": {
"type": "string",
"description": "The id for the ViewQueueGroup object."
}
}
},
"A plugin DTO for Datasources.": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the datasource type."
},
"datasourceType": {
"type": "string",
"description": "The datasource type."
},
"configResourcePath": {
"type": "string",
"description": "The config resource path for the plugin dto."
},
"hasCustomInterface": {
"default": false,
"type": "boolean",
"description": "If true the datasource type has its own custom interface."
},
"testable": {
"default": false,
"type": "boolean",
"description": "If true the datasource can be tested."
},
"entryControlResourcePath": {
"type": "string",
"description": "The entry control resource path for the plugin dto."
}
}
},
"The cold narrative configuration": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "Ordinal of the cold narrative.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Flag indicating the cold narrative is to be deleted."
},
"description": {
"type": "string",
"description": "Description of the cold narrative."
},
"coldNarrative": {
"type": "string",
"description": "Script of the cold narrative."
},
"rawFileUnderTest": {
"type": "string",
"description": "Path to the raw file to be tested."
},
"id": {
"type": "string",
"description": "The id of the cold narrative."
},
"name": {
"type": "string",
"description": "Name of the cold narrative."
}
}
},
"PrintFaxDevice": {
"required": [
"alias",
"deviceType"
],
"type": "object",
"properties": {
"deviceProperties": {
"items": {
"$ref": "#/definitions/DeviceProperty"
},
"type": "array"
},
"deviceIdentitifer": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"server": {
"$ref": "#/definitions/PrintFaxServer"
},
"alias": {
"type": "string"
},
"deviceType": {
"enum": [
"PRINTER",
"FAX"
],
"type": "string"
},
"assignedGroups": {
"items": {
"$ref": "#/definitions/DeviceGroup"
},
"type": "array"
},
"id": {
"type": "string"
}
}
},
"SearchDocIndexingMetadata": {
"required": [
"metadata",
"valueType"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"valueType": {
"enum": [
"VARIABLE",
"STATIC",
"DATASOURCE"
],
"type": "string"
},
"value": {
"type": "string"
},
"searchDocIndexing": {
"$ref": "#/definitions/SearchDocIndexing"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"Diary": {
"required": [
"entry"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"entryId": {
"type": "string"
},
"user": {
"$ref": "#/definitions/User"
},
"entry": {
"type": "string"
},
"document": {
"$ref": "#/definitions/Document"
},
"id": {
"type": "string"
}
}
},
"FormControlProperty": {
"required": [
"propertyName",
"propertyValue"
],
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean"
},
"propertyName": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyValue": {
"type": "string"
},
"formControlStep": {
"$ref": "#/definitions/FormControlStep"
},
"id": {
"type": "string"
}
}
},
"DocumentType data used to create a new document type based off an existing document type.": {
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD",
"DELETED"
],
"type": "string",
"description": "The type of document type."
},
"fullText": {
"default": false,
"type": "boolean",
"description": "Flag to indicate document type is full texted."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The flag to indicate if document type is marked for deletion."
},
"description": {
"type": "string",
"description": "The description of the document type."
},
"newDocumentTypeDto": {
"description": "The new document type dto to create.",
"$ref": "#/definitions/DocumentType data used to configure document types for the system."
},
"copyProcessModelFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type process models should be copied or not."
},
"copyRetentionPolicyFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type retention policy should be copied or not."
},
"retentionPolicy": {
"description": "The retention policy associated with the document type.",
"$ref": "#/definitions/RetentionPolicyDTO"
},
"existingDocumentTypeId": {
"type": "string",
"description": "The ID of the existing document type to copy."
},
"copyMetadataFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type metadata should be copied or not."
},
"categoryId": {
"type": "string",
"description": "The ID of the category the document type is associated with."
},
"copyIndexingFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type indexing configuration should be copied or not."
},
"copyScanProfileFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type scan profiles should be copied or not."
},
"version": {
"default": false,
"type": "boolean",
"description": "The version of the document type."
},
"documentCount": {
"type": "integer",
"description": "The count of the documents associated with the document type.",
"format": "int64"
},
"categoryName": {
"type": "string",
"description": "The name of the category the document type is associated with."
},
"copySecurityFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type security should be copied or not."
},
"copyFullTextFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type full text should be copied or not."
},
"id": {
"type": "string",
"description": "The ID of the document type."
},
"copyOverlaysFlag": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the document type overlays should be copied or not."
},
"name": {
"type": "string",
"description": "The name of the document type."
}
}
},
"A single feature right assigned to a group.": {
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"featureRightName": {
"type": "string",
"description": "The feature right name."
},
"classificationId": {
"type": "string",
"description": "The permission classification ID."
},
"featureRightDescription": {
"type": "string",
"description": "The feature right description."
},
"featureRightId": {
"type": "string",
"description": "The feature right ID."
},
"assigned": {
"default": false,
"type": "boolean",
"description": "Whether the group is assigned this right. Setting to false will remove the feature right."
},
"groupName": {
"type": "string",
"description": "The group name."
},
"permissionKey": {
"type": "string",
"description": "The permission key."
},
"id": {
"type": "string",
"description": "The ID."
},
"classificationName": {
"type": "string",
"description": "The classification name."
},
"groupId": {
"type": "string",
"description": "The group ID."
}
}
},
"A table chart.": {
"allOf": [
{
"$ref": "#/definitions/The representation of a Chart object."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"STANDARD"
],
"type": "string",
"description": "The chart status."
},
"datasourceInputs": {
"items": {
"$ref": "#/definitions/A required input to the datasource used by a chart."
},
"type": "array",
"description": "The required inputs to the chart's datasource."
},
"properties": {
"description": "The chart's display properties.",
"$ref": "#/definitions/An object that encapsulates all of the display properties for a chart."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by the chart."
},
"name": {
"type": "string",
"description": "The name of the chart. Must be unique."
},
"lockOwnerLastName": {
"type": "string",
"description": "The username of the user who has locked this chart for editing."
},
"overrideErrorsOnSave": {
"default": false,
"type": "boolean",
"description": "Whether to override errors encountered when saving the chart."
},
"isValid": {
"default": false,
"type": "boolean",
"description": "Whether the chart is in a valid state."
},
"variables": {
"items": {
"$ref": "#/definitions/A variable exposed as required input to a chart."
},
"type": "array",
"description": "The variables exposed as required inputs to the chart."
},
"lockOwnerFirstName": {
"type": "string",
"description": "The first name of the user who has locked this chart for editing."
},
"dateModified": {
"type": "string",
"description": "The date and time that the chart was last modified.",
"format": "date-time"
},
"sortColumns": {
"items": {
"$ref": "#/definitions/A column definition for a table chart."
},
"type": "array",
"description": "The sortable columns."
},
"isLocked": {
"default": false,
"type": "boolean",
"description": "Whether the chart is currently locked for editing."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the chart."
},
"dashboardCount": {
"type": "integer",
"description": "The number of dashboards that use this chart as either a top level chart or a drilldown.",
"format": "int64"
},
"refreshInterval": {
"type": "integer",
"description": "Unused.",
"format": "int64"
},
"datasourceParameters": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "Unused."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"GAUGE",
"PIE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"id": {
"type": "string",
"description": "The chart ID."
},
"columns": {
"items": {
"$ref": "#/definitions/A column definition for a table chart."
},
"type": "array",
"description": "The table columns."
},
"lockOwner": {
"type": "string",
"description": "The username of the user who has the chart locked for editing."
}
}
}
]
},
"An object that defines a print or fax device.": {
"required": [
"alias",
"deviceIdentifier",
"deviceType"
],
"type": "object",
"properties": {
"deviceProperties": {
"items": {
"$ref": "#/definitions/DevicePropertyDTO"
},
"type": "array",
"description": "The configured properties for the device."
},
"properties": {
"items": {
"enum": [
"PRINT_PRINTER_NAME",
"PRINT_DUPLEX",
"PRINT_TUMBLE",
"PRINT_LANDSCAPE",
"PRINT_PORTRAIT",
"PRINT_NUMBER_OF_COPIES",
"PRINT_COLOR",
"PRINT_BLACK_AND_WHITE",
"PRINT_UNCOLLATED",
"PRINT_COLLATED",
"PRINT_JOB_SHEET",
"PRINT_PAGE_RANGE",
"FAX_FAX_SERVICE_NAME",
"FAX_FAX_RECIPIENT_NUMBER",
"FAX_TO_NAME",
"FAX_FROM_NAME"
],
"type": "string"
},
"type": "array",
"description": "The names of the properties supported by the device."
},
"deviceIdentifier": {
"type": "string",
"description": "The device unique identifier at the OS level."
},
"operational": {
"default": false,
"type": "boolean",
"description": "Whether the device is currently operational."
},
"alias": {
"type": "string",
"description": "The user-friendly name of the device."
},
"deviceType": {
"enum": [
"PRINTER",
"FAX"
],
"type": "string",
"description": "The type of device."
},
"serverDto": {
"description": "The full DTO for the server where this device resides.",
"$ref": "#/definitions/An object that defines print or fax server."
},
"assignedGroups": {
"items": {
"$ref": "#/definitions/DeviceGroupDTO"
},
"type": "array",
"description": "The DocFinity Groups that are assigned access to this device."
},
"id": {
"type": "string",
"description": "The unique ID of the device."
}
}
},
"DispositionQueueItem": {
"required": [
"dispositionQueue",
"document"
],
"type": "object",
"properties": {
"approvals": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DispositionQueueApproval"
},
"type": "array"
},
"dispositionQueue": {
"$ref": "#/definitions/DispositionQueue"
},
"document": {
"$ref": "#/definitions/Document"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"The definition of the paramters used by the stored procedure.": {
"type": "object",
"properties": {
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The corressponding datatype in DocFinity."
},
"sqlType": {
"type": "string",
"description": "The sql types of the parameter used by the stored procedure. The possible values are The possible sql types are: <p> VARCHAR<br> DATE<br> BOOLEAN<br> LONGVARCHAR<br> CHAR<br> TIME<br> TIMESTAMP<br> DOUBLE<br> FLOAT<br> SMALLINT<br> INTEGER<br> DECIMAL<br> BIGINT<br> NUMERIC<br> TINYINT<br> ARRAY<br> BINARY<br> BIT<br> BLOB<br> CLOB<br> DATALINK<br> DISTINCT<br> JAVA_OBJECT<br> NULL<br> REAL<br> REF<br> STRUCT<br> VARBINARY<br> LONGVARBINARY<br> NUMBER<br> OTHER<p>"
},
"type": {
"type": "string",
"description": "The type of the parameter used by the stored procedure.Possible values are IN, INOUT, OUT"
},
"name": {
"type": "string",
"description": "The name of the parameter used by the stored procedure."
}
}
},
"SQLWarning": {
"type": "object",
"properties": {
"stackTrace": {
"items": {
"$ref": "#/definitions/StackTraceElement"
},
"type": "array"
},
"suppressed": {
"items": {
"$ref": "#/definitions/Throwable"
},
"type": "array"
},
"nextException": {
"$ref": "#/definitions/SQLException"
},
"localizedMessage": {
"type": "string"
},
"errorCode": {
"type": "integer",
"format": "int32"
},
"sqlstate": {
"type": "string"
},
"nextWarning": {
"$ref": "#/definitions/SQLWarning"
},
"cause": {
"$ref": "#/definitions/Throwable"
},
"message": {
"type": "string"
}
}
},
"A user prompt input that allows a datasource and is required.": {
"allOf": [
{
"$ref": "#/definitions/A user prompt input."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"promptType": {
"enum": [
"SWITCH",
"DATE",
"TEXT",
"DROP_DOWN_LIST"
],
"type": "string",
"description": "The prompt type."
},
"required": {
"default": false,
"type": "boolean",
"description": "Whether the input is required."
},
"value": {
"type": "object"
},
"label": {
"type": "string",
"description": "The prompt label."
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"defaultValueType": {
"enum": [
"STATIC",
"MACRO",
"DATASOURCE",
"FIRST",
"SPECIFIC",
"PROMPT"
],
"type": "string",
"description": "The default value type."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"RetentionPolicyCustodianDTO": {
"type": "object",
"properties": {
"userName": {
"type": "string"
},
"ordinal": {
"type": "integer",
"format": "int32"
},
"retentionPolicyId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"userId": {
"type": "string"
},
"id": {
"type": "string"
},
"delete": {
"xml": {
"name": "deleted"
},
"default": false,
"type": "boolean"
}
}
},
"Throwable": {
"type": "object",
"properties": {
"localizedMessage": {
"type": "string"
},
"stackTrace": {
"items": {
"$ref": "#/definitions/StackTraceElement"
},
"type": "array"
},
"message": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/Throwable"
},
"suppressed": {
"items": {
"$ref": "#/definitions/Throwable"
},
"type": "array"
}
}
},
"Transfer class for details about a previous synchronziation attempt.": {
"type": "object",
"properties": {
"usersDeleted": {
"type": "integer",
"description": "Number of users deleted.",
"format": "int64"
},
"usersModified": {
"type": "integer",
"description": "Number of users modified.",
"format": "int64"
},
"usersAdded": {
"type": "integer",
"description": "Number of users added.",
"format": "int64"
},
"elapsed": {
"type": "integer",
"description": "Time elapsed from sync start to sync end.",
"format": "int64"
},
"groupsDeleted": {
"type": "integer",
"description": "Number of groups deleted.",
"format": "int64"
},
"errors": {
"type": "integer",
"description": "Number of errors.",
"format": "int64"
},
"details": {
"type": "integer",
"description": "Number of details.",
"format": "int64"
},
"groupsModified": {
"type": "integer",
"description": "Number of groups modified.",
"format": "int64"
},
"groupsAdded": {
"type": "integer",
"description": "Number of groups added.",
"format": "int64"
}
}
},
"ServiceDTO": {
"type": "object",
"properties": {
"operations": {
"xml": {
"name": "operation"
},
"items": {
"$ref": "#/definitions/OperationDTO"
},
"type": "array"
},
"name": {
"type": "string"
}
}
},
"TaskPropertyDTO": {
"type": "object",
"properties": {
"propertyName": {
"type": "string"
},
"id": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
},
"DispositionQueueApproval": {
"required": [
"item",
"status",
"user"
],
"type": "object",
"properties": {
"status": {
"enum": [
"APPROVED",
"POSTPONED"
],
"type": "string"
},
"approvalDate": {
"type": "string",
"format": "date-time"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"item": {
"$ref": "#/definitions/DispositionQueueItem"
},
"user": {
"$ref": "#/definitions/User"
},
"id": {
"type": "string"
}
}
},
"The representation of the SearchChecklistSubSearch domain object. Note that this object works with the composition context of a Search dto. Sub searches are used within searches of type CHECKLIST. Each sub search can be seen as the logic portion of a search, determining which documents are returned. A checklist search is comprised of multiple sub searches, each of which is 'met' when it returns one or more documents that match its' parameters, or criteria.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal associated to this checklist search subsearch.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The flag indicating that this checklist search subsearch is to be deleted."
},
"name": {
"type": "string",
"description": "The name associated to this checklist search subsearch."
},
"searchChecklistParameters": {
"items": {
"$ref": "#/definitions/The representation of the parameter objects associated with a subsearch."
},
"type": "array",
"description": "The list of parameters used by the checklist search subsearch."
},
"required": {
"default": false,
"type": "boolean",
"description": "The flag indicating that results are required of this checklist search subsearch."
},
"id": {
"type": "string",
"description": "The unique identifier of the checklist search subsearch."
}
}
},
"The validator associated with the view prompt.": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name associated with the view prompt."
},
"id": {
"type": "string",
"description": "The validator id associated with the view prompt."
}
}
},
"FormControl": {
"required": [
"name",
"type"
],
"type": "object",
"properties": {
"controlSteps": {
"items": {
"$ref": "#/definitions/FormControlStep"
},
"type": "array"
},
"name": {
"type": "string"
},
"deletedFormControlSteps": {
"items": {
"$ref": "#/definitions/FormControlStep"
},
"type": "array"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formId": {
"type": "string"
},
"disabled": {
"default": false,
"type": "boolean"
},
"deleted": {
"default": false,
"type": "boolean"
},
"form": {
"$ref": "#/definitions/Form"
},
"hidden": {
"default": false,
"type": "boolean"
},
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"An object that defines the border for a chart.": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the border."
},
"type": {
"type": "string",
"description": "The type of the border."
},
"size": {
"type": "integer",
"description": "The size of the border.",
"format": "int32"
}
}
},
"The representation of the document indexing configuration of a search.": {
"type": "object",
"properties": {
"allowDocCreation": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the search could be transformed into an indexed document."
},
"documentTypeId": {
"type": "string",
"description": "The unique identifier of the document type to index the document/search to."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication of the intent to delete the search document indexing configuration."
},
"categoryName": {
"type": "string",
"description": "The category name to index the document/search to."
},
"categoryId": {
"type": "string",
"description": "The unique identifier of the category to index the document/search to."
},
"id": {
"type": "string",
"description": "The unique identifier of the document indexing configuration of the search."
},
"documentTypeName": {
"type": "string",
"description": "The document type name to index the document/search to."
},
"metadata": {
"items": {
"$ref": "#/definitions/SearchDocIndexingMetadataDTO"
},
"type": "array",
"description": "The metadata associated with the document indexing configuration."
}
}
},
"ScanSetting": {
"required": [
"deleteBackOfSeparator",
"dpiResolution",
"name",
"scanSettingType",
"simulateDuplex",
"storageType"
],
"type": "object",
"properties": {
"docFinitySeparator": {
"default": false,
"type": "boolean"
},
"documentTypeScanSettings": {
"items": {
"$ref": "#/definitions/DocumentTypeScanSetting"
},
"type": "array"
},
"convertToPdf": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"duplex": {
"default": false,
"type": "boolean"
},
"saveToServer": {
"default": false,
"type": "boolean"
},
"dpiResolution": {
"type": "integer",
"format": "int32"
},
"multipage": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"externalDirPath": {
"type": "string"
},
"deleteBackOfSeparator": {
"default": false,
"type": "boolean"
},
"scanSettingType": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string"
},
"storageType": {
"$ref": "#/definitions/StorageType"
},
"scanSettingGroups": {
"items": {
"$ref": "#/definitions/ScanSettingGroup"
},
"type": "array"
},
"scanToExternalDir": {
"default": false,
"type": "boolean"
},
"simulateDuplex": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
}
}
},
"DocfinityTaskDTO": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"processID": {
"type": "integer",
"format": "int64"
},
"helpDescription": {
"type": "string"
},
"taskProperties": {
"items": {
"$ref": "#/definitions/TaskPropertyDTO"
},
"type": "array"
},
"conditionPassed": {
"default": false,
"type": "boolean"
},
"completed": {
"default": false,
"type": "boolean"
},
"required": {
"default": false,
"type": "boolean"
},
"runSwfName": {
"type": "string"
},
"jobId": {
"type": "string"
},
"redoable": {
"default": false,
"type": "boolean"
},
"jobName": {
"type": "string"
},
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"condition": {
"type": "string"
},
"desc": {
"type": "string"
}
}
},
"DTO representing shift membership changes.": {
"type": "object",
"properties": {
"updateType": {
"enum": [
"USER",
"GROUP"
],
"type": "string",
"description": "Gets the update type attribute of the object."
},
"shiftId": {
"type": "string",
"description": "Id of the shift that is the target of the operation."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"description": "Gets the entity ids that should be used to populate the shift, based on update type."
}
}
},
"DocumentTypeGroup": {
"required": [
"documentType",
"group"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"group": {
"$ref": "#/definitions/Group"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentSecurities": {
"items": {
"$ref": "#/definitions/DocumentSecurity"
},
"type": "array"
},
"id": {
"type": "string"
}
}
},
"Representation of scan settings.": {
"type": "object",
"properties": {
"convertToPdf": {
"default": false,
"type": "boolean"
},
"deleteBackOfSeparator": {
"default": false,
"type": "boolean"
},
"scanSettingType": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The type of the scan setting."
},
"blankDeviationThreshold": {
"type": "integer",
"description": "The blank deviation threshold of the scan settings.",
"format": "int32"
},
"scanToExternalDir": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the operation should scan to an external directory."
},
"id": {
"type": "string",
"description": "The ID of the scan setting."
},
"blankPageThreshold": {
"type": "integer",
"description": "The threshold of blank pages configured for the scan settings.",
"format": "int64"
},
"showUI": {
"default": false,
"type": "boolean",
"description": "The flag indicating if the scanning user interface should be shown."
},
"compression": {
"type": "string",
"description": "The compression attribute of the scan settings."
},
"duplex": {
"default": false,
"type": "boolean",
"description": "The flag indicating if this scan profile supports duplex scanning."
},
"saveToServer": {
"default": false,
"type": "boolean"
},
"dpiResolution": {
"type": "integer",
"description": "The DPI resolution setting for the scan profile.",
"format": "int32"
},
"externalDirPath": {
"type": "string",
"description": "The representation of the external directory path in which to save scans."
},
"automaticDocumentFeeder": {
"default": false,
"type": "boolean",
"description": "The flag indicating support of automatic document feeder."
},
"deleteBlankPage": {
"default": false,
"type": "boolean",
"description": "The flag indicating if blank pages should be deleted."
},
"storageTypeDescription": {
"type": "string",
"description": "The description of the storage type."
},
"docFinitySeparator": {
"default": false,
"type": "boolean",
"description": "The flag indicating to use the DocFinity separator."
},
"name": {
"type": "string",
"description": "The name of the scan setting."
},
"pixelType": {
"type": "integer",
"description": "The pixel type of the scan setting.",
"format": "int32"
},
"simulateDuplex": {
"default": false,
"type": "boolean"
},
"multipage": {
"default": false,
"type": "boolean",
"description": "The flag indicating if this scan setting support multipage scanning."
},
"storageTypeId": {
"type": "integer",
"description": "The indicator of the storage type.",
"format": "int64"
},
"operationId": {
"type": "string"
}
}
},
"LegalHoldCase": {
"required": [
"custodians",
"dateOpened",
"description",
"name",
"openedBy"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"closedBy": {
"$ref": "#/definitions/User"
},
"heldRecords": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/LegalHold"
},
"type": "array"
},
"dateOpened": {
"type": "string",
"format": "date-time"
},
"openedBy": {
"$ref": "#/definitions/User"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"dateClosed": {
"type": "string",
"format": "date-time"
},
"custodians": {
"uniqueItems": true,
"items": {
"$ref": "#/definitions/LegalHoldCustodian"
},
"type": "array"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"The definition of a stored procedure stored in a database.": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the stored procedure."
},
"parameters": {
"items": {
"$ref": "#/definitions/The definition of the paramters used by the stored procedure."
},
"type": "array",
"description": "The parameter array of the stored procedure."
},
"schema": {
"type": "string",
"description": "The schema name of the database where the stored procedure is saved."
}
}
},
"An object importer.": {
"allOf": [
{
"$ref": "#/definitions/A parent class for all Kendo charts."
},
{
"type": "object",
"properties": {
"status": {
"enum": [
"INTERNAL",
"ACTIVE"
],
"type": "string",
"description": "The importer status INTERNAL/EXTERNAL."
},
"directoryPath": {
"type": "string",
"description": "The directory path being monitored by the importer."
},
"preRender": {
"default": false,
"type": "boolean",
"description": "Flag indicating that files imported by the importer will be pre-rendered."
},
"calculatedProperties": {
"items": {
"$ref": "#/definitions/The representation of the calculated property associated with the importer."
},
"type": "array",
"description": "The calculated properties to be used by the importer."
},
"importerPluginName": {
"type": "string",
"description": "The plugin to be used by the importer."
},
"description": {
"type": "string",
"description": "The description to be used by the importer."
},
"schedule": {
"description": "The importer schedule.",
"$ref": "#/definitions/DTO for a GenericSchedule entity."
},
"get_class": {
"type": "string"
},
"fileFilter": {
"type": "string",
"description": "The file filter to be used by the importer."
},
"idle": {
"default": false,
"type": "boolean",
"description": "Flag indicating importer is running but not processing."
},
"server": {
"type": "string",
"description": "The server details where the importer will run."
},
"running": {
"default": false,
"type": "boolean",
"description": "Flag indicating that the importer is running."
},
"serial": {
"default": false,
"type": "boolean",
"description": "Flag indicating the files are to be processed serially."
},
"pollingUnits": {
"enum": [
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"type": "string",
"description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS."
},
"lastErrorMessage": {
"type": "string",
"description": "The last error message associated with the importer."
},
"pollingFrequency": {
"type": "integer",
"description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder.",
"format": "int32"
},
"ruleSets": {
"items": {
"$ref": "#/definitions/The rule set associated with the importer."
},
"type": "array",
"description": "The rulesets to be used by the importer."
},
"processType": {
"enum": [
"EMAIL",
"REPORT",
"INDEX",
"OBJECT",
"COLD"
],
"type": "string",
"description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX."
},
"id": {
"type": "string",
"description": "The id of the importer."
},
"pending": {
"default": false,
"type": "boolean",
"description": "Flag indicating that start/stop of importer is pending."
},
"name": {
"type": "string",
"description": "The name of the importer."
}
}
}
]
},
"FormControlStepDTO": {
"type": "object",
"properties": {
"labelPosition": {
"enum": [
"LEFT",
"RIGHT",
"TOP",
"BOTTOM"
],
"type": "string"
},
"height": {
"type": "integer",
"format": "int32"
},
"disabled": {
"type": "string"
},
"validators": {
"items": {
"$ref": "#/definitions/FormControlValidatorDTO"
},
"type": "array"
},
"formStepId": {
"type": "string"
},
"percentHeight": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"disabledConditionConfigData": {
"items": {
"$ref": "#/definitions/A DTO for complex data used in the macro builder for hidden, required, and disabled properties."
},
"type": "array"
},
"formStepName": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"label": {
"type": "string"
},
"width": {
"type": "integer",
"format": "int32"
},
"percentWidth": {
"type": "integer",
"format": "int32"
},
"hidden": {
"type": "string"
},
"datasource": {
"type": "string"
},
"hiddenConditionConfigData": {
"items": {
"$ref": "#/definitions/A DTO for complex data used in the macro builder for hidden, required, and disabled properties."
},
"type": "array"
},
"formStepOrdinal": {
"type": "integer",
"format": "int32"
},
"datasourceObject": {
"$ref": "#/definitions/The definition of a data source."
},
"deleted": {
"default": false,
"type": "boolean"
},
"requiredConditionConfigData": {
"items": {
"$ref": "#/definitions/A DTO for complex data used in the macro builder for hidden, required, and disabled properties."
},
"type": "array"
},
"actions": {
"items": {
"$ref": "#/definitions/FormActionDTO"
},
"type": "array"
},
"properties": {
"items": {
"$ref": "#/definitions/FormControlPropertyDTO"
},
"type": "array"
},
"required": {
"type": "string"
},
"formControlName": {
"type": "string"
},
"loadOrder": {
"type": "integer",
"format": "int32"
},
"y": {
"type": "integer",
"format": "int32"
},
"x": {
"type": "integer",
"format": "int32"
},
"formControlId": {
"type": "string"
}
}
},
"FormActionPropertyDTO": {
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean"
},
"propertyName": {
"type": "string"
},
"id": {
"type": "string"
},
"propertyValue": {
"type": "string"
}
}
},
"Represents the relationship between an Overlay and a Document Type.": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "string",
"description": "The ID of the document type to which the overlay is assigned."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"overlayName": {
"type": "string",
"description": "The name of the overlay, read-only."
},
"offsetX": {
"type": "integer",
"description": "Number of pixels on the X axis to offset the overlay when rendering.",
"format": "int32"
},
"defaultTo": {
"default": false,
"type": "boolean",
"description": "Whether this overlay is the default for all pages where another overlay is not specified."
},
"offsetY": {
"type": "integer",
"description": "Number of pixels on the Y axis to offset the overlay when rendering.",
"format": "int32"
},
"range": {
"type": "string",
"description": "The page range where the overlay is applied. For default overlays, use 0. Supports any combination of: specific page (3), page range (3-10), wildcards (*-10, 3-*), in a comma-separated list: 1,4,3-7,10-*."
},
"overlayId": {
"type": "string",
"description": "The ID of the overlay."
},
"documentTypeOverlayId": {
"type": "string",
"description": "The ID of the object."
},
"id": {
"type": "string",
"description": "The ID of the object."
}
}
},
"DocumentSecurity": {
"required": [
"documentTypeGroup",
"permissionType"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"markedForFilterDelete": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentTypeGroup": {
"$ref": "#/definitions/DocumentTypeGroup"
},
"permissionType": {
"enum": [
"LIST",
"VIEW",
"DELETE",
"UPDATE",
"EDIT",
"OVERRIDE_REDACTIONS",
"VIEW_MARKUP"
],
"type": "string"
},
"securityFilters": {
"items": {
"$ref": "#/definitions/SecurityFilter"
},
"type": "array"
},
"id": {
"type": "string"
}
}
},
"DTO describing the results of synchronization between an Ldap and DocFinity entity.": {
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"description": "The user status associated with the object."
},
"name": {
"type": "string",
"description": "The entity name associated with the object."
},
"entityType": {
"enum": [
"USER",
"GROUP",
"SYSTEM"
],
"type": "string",
"description": "Describes the type of LDAP object that was synced."
},
"modifiedTimeStamp": {
"type": "integer",
"description": "The modified time stamp associated with the user.",
"format": "int64"
},
"lastSyncAction": {
"enum": [
"ADDED",
"MODIFIED",
"DELETED",
"ERROR"
],
"type": "string",
"description": "The last action performed during synchronization."
},
"id": {
"type": "string",
"description": "Unique ID."
}
}
},
"LdapServerDTO object contains connection and user lookup details for the ldap server.": {
"type": "object",
"properties": {
"serverType": {
"enum": [
"ACTIVE_DIRECTORY",
"STANDARD_LDAP"
],
"type": "string",
"description": "Gets the ldap server type."
},
"baseDNs": {
"items": {
"type": "string"
},
"type": "array",
"description": "Gets the BaseDn array attribute of the LdapServerDTO object."
},
"groupEntityFilter": {
"type": "string",
"description": "Gets the group entity filter."
},
"serverPort": {
"type": "string",
"description": "Gets the serverPort attribute of the LdapServerDTO object."
},
"useBaseDn": {
"default": false,
"type": "boolean",
"description": "Gets the useBaseDn attribute of the LdapServerDTO object."
},
"modifiedTimeStampAttr": {
"type": "string",
"description": "Gets the modifiedTimeStampAttr attribute of the LdapServerDTO object."
},
"serverName": {
"type": "string",
"description": "Gets the serverName attribute of the LdapServerDTO object."
},
"baseDn": {
"type": "string",
"description": "Gets the baseDn attribute of the LdapServerDTO object."
},
"groupsValid": {
"default": false,
"type": "boolean",
"description": "Gets groups valid attribute."
},
"firstNameAttr": {
"type": "string",
"description": "Gets the firstNameAttr attribute of the LdapServerDTO object."
},
"ldapServerType": {
"type": "string"
},
"subDn": {
"type": "string",
"description": "Gets the subDn attribute of the LdapServerDTO object."
},
"memberOfAttr": {
"type": "string",
"description": "Used to determine group memberships."
},
"groupNameAttr": {
"type": "string",
"description": "Gets group name attribute."
},
"synchronizeGroups": {
"default": false,
"type": "boolean",
"description": "Gets whether to synchronize groups."
},
"userFilter": {
"type": "string",
"description": "Gets the userFilter attribute of the LdapServerDTO object."
},
"externalReferenceAttr": {
"type": "string",
"description": "Gets the externalReferenceAttr attribute of the LdapServerDTO object."
},
"emailAddressAttr": {
"type": "string",
"description": "Gets the emailAddressAttr attribute of the LdapServerDTO object."
},
"userDn": {
"type": "string",
"description": "Gets the userDn attribute of the LdapServerDTO object."
},
"lastNameAttr": {
"type": "string",
"description": "Gets the lastNameAttr attribute of the LdapServerDTO object."
},
"userStatusAttr": {
"type": "string",
"description": "Gets the userStatusAttr attribute of the LdapServerDTO object."
},
"middleNameAttr": {
"type": "string",
"description": "Gets the middleNameAttr attribute of the LdapServerDTO object."
},
"password": {
"type": "string",
"description": "Gets the password attribute of the LdapServerDTO object."
},
"phoneNumberAttr": {
"type": "string",
"description": "Gets the phoneNumberAttr attribute of the LdapServerDTO object."
},
"usernameAttr": {
"type": "string",
"description": "Gets the usernameAttr attribute of the LdapServerDTO object."
},
"ssl": {
"default": false,
"type": "boolean",
"description": "Gets the ssl attribute of the LdapServerDTO object."
},
"enabled": {
"default": false,
"type": "boolean",
"description": "Gets the enabled attribute of the LdapServerDTO object."
},
"synchronizeAllGroups": {
"default": false,
"type": "boolean",
"description": "Gets whether to sychronize all groups."
},
"valid": {
"default": false,
"type": "boolean",
"description": "Gets users valid attribute."
}
}
},
"A DTO for adding a group and all of its associations on one operation.": {
"type": "object",
"properties": {
"featureRights": {
"items": {
"$ref": "#/definitions/A single feature right assigned to a group."
},
"type": "array",
"description": "The feature rights that should be given to this group."
},
"group": {
"description": "The details for the new group.",
"$ref": "#/definitions/An object representing a group."
},
"security": {
"items": {
"$ref": "#/definitions/An object that assigns document security to a group."
},
"type": "array",
"description": "The document security that should be given to this group."
},
"members": {
"items": {
"$ref": "#/definitions/A member of a group."
},
"type": "array",
"description": "The users who should be added to this group."
}
}
},
"RetentionPolicyCustodian": {
"required": [
"retentionPolicy",
"user"
],
"type": "object",
"properties": {
"ordinal": {
"minimum": 0.0,
"type": "integer",
"format": "int32"
},
"create": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"retentionPolicy": {
"$ref": "#/definitions/RetentionPolicy"
},
"user": {
"$ref": "#/definitions/User"
},
"id": {
"type": "string"
},
"delete": {
"default": false,
"type": "boolean"
}
}
},
"An object representing a query for group members.": {
"type": "object",
"properties": {
"sorts": {
"items": {
"$ref": "#/definitions/A generic sort object that allows you to sort by a named field in either direction."
},
"type": "array",
"description": "Any sorts to apply."
},
"startIndex": {
"type": "integer",
"description": "The start index for paging.",
"format": "int32"
},
"groupIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "The group IDs."
},
"maxResults": {
"type": "integer",
"description": "The max results for a page.",
"format": "int32"
},
"filters": {
"description": "The filters.",
"$ref": "#/definitions/A generic collection of filter objects that can be applied to get requests."
}
}
},
"DatabaseConnection": {
"required": [
"acquireAttempts",
"acquireIncrement",
"archive",
"databaseDriverName",
"initialPoolSize",
"maxIdleTime",
"maxPoolSize",
"minPoolSize",
"name",
"password",
"username"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"dbUrl": {
"type": "string"
},
"addMode": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
},
"archive": {
"default": false,
"type": "boolean"
},
"encryptedPassword": {
"type": "string"
},
"serverName": {
"type": "string"
},
"nameChanged": {
"default": false,
"type": "boolean"
},
"port": {
"type": "integer",
"format": "int32"
},
"minPoolSize": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
},
"databaseMetadata": {
"$ref": "#/definitions/DatabaseMetaData"
},
"initialPoolSize": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
},
"validateInitialPoolSizeLessThanEqualToMax": {
"default": false,
"type": "boolean"
},
"username": {
"type": "string"
},
"validateInitialPoolSizeGreaterThanEqualToMin": {
"default": false,
"type": "boolean"
},
"description": {
"type": "string"
},
"maxPoolSizeErrorMessage": {
"type": "string"
},
"customUrl": {
"type": "string"
},
"databaseDriverName": {
"type": "string"
},
"acquireAttempts": {
"minimum": 0.0,
"type": "integer",
"maximum": 100.0,
"format": "int32"
},
"validateMinPoolSizeLessThanEqualToMax": {
"default": false,
"type": "boolean"
},
"databaseName": {
"type": "string"
},
"databaseVendor": {
"enum": [
"MSSQL",
"ORACLE",
"DB2",
"CUSTOM"
],
"type": "string"
},
"password": {
"type": "string"
},
"acquireIncrement": {
"minimum": 1.0,
"type": "integer",
"maximum": 1000.0,
"format": "int32"
},
"name": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"maxIdleTime": {
"minimum": 0.0,
"type": "integer",
"maximum": 86400.0,
"format": "int32"
},
"maxPoolSize": {
"minimum": 1.0,
"type": "integer",
"maximum": 10000.0,
"format": "int32"
},
"originalName": {
"type": "string"
}
}
},
"Attachment": {
"type": "object",
"properties": {
"contentType": {
"$ref": "#/definitions/MediaType"
},
"dataHandler": {
"$ref": "#/definitions/DataHandler"
},
"contentId": {
"type": "string"
},
"object": {
"type": "object"
},
"headers": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"contentDisposition": {
"$ref": "#/definitions/ContentDisposition"
}
}
},
"Entry for a logging module.": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display name."
},
"name": {
"type": "string",
"description": "Logger name."
},
"level": {
"enum": [
"OFF",
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
"TRACE",
"ALL"
],
"type": "string",
"description": "Log level."
}
}
},
"SearchResultFormDTO": {
"type": "object",
"properties": {
"searchFormData": {
"items": {
"$ref": "#/definitions/FormInstanceDataDTO"
},
"type": "array"
},
"formEditable": {
"default": false,
"type": "boolean"
},
"formDesignName": {
"type": "string"
}
}
},
"Represents the configuration for a single part of batch names.": {
"type": "object",
"properties": {
"included": {
"default": false,
"type": "boolean",
"description": "Whether this configuration part is included in batch names."
},
"ordinal": {
"type": "integer",
"description": "The order in which this configuration part appears in the batch name, if included.",
"format": "int32"
},
"id": {
"type": "integer",
"description": "The ID of this configuration property.",
"format": "int64"
},
"value": {
"type": "string",
"description": "A custom value used as the portion of the batch name (applies to static text only)."
},
"name": {
"type": "string",
"description": "The name of this configuration part."
}
}
},
"DeviceProperty": {
"required": [
"name",
"printFaxDevice"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"printFaxDevice": {
"$ref": "#/definitions/PrintFaxDevice"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"Amalgamated view of license usage vs availability.": {
"type": "object",
"properties": {
"dedicatedLicensesConsumed": {
"type": "integer",
"description": "Total licenses assigned to specific users that are in use.",
"format": "int64"
},
"totalLicensesConsumed": {
"type": "integer",
"description": "Total licenses available to the system, or -1 if enterprise.",
"format": "int64"
},
"groupLicensesConsumed": {
"type": "integer",
"description": "Total licenses assigned to groups that are in use.",
"format": "int64"
},
"floatingLicensesConsumed": {
"type": "integer",
"description": "Total floating licenses that are in use.",
"format": "int64"
},
"dedicatedLicensesAvailable": {
"type": "integer",
"description": "Total number of licenses assigned to specific users.",
"format": "int64"
},
"enterprise": {
"default": false,
"type": "boolean",
"description": "If true, the license is an enterprise license."
},
"groupLicensesAvailable": {
"type": "integer",
"description": "Total number of licenses assigned to groups.",
"format": "int64"
},
"totalLicensesAvailable": {
"type": "integer",
"description": "Total licenses available to the system, or -1 if enterprise.",
"format": "int64"
},
"floatingLicensesAvailable": {
"type": "integer",
"description": "Total number of licenses that are not dedicated or group-assigned.",
"format": "int64"
}
}
},
"DTO for a GenericSchedule entity.": {
"type": "object",
"properties": {
"target": {
"type": "string",
"description": "Gets the target attribute of the GenericScheduleDTO object."
},
"enabled": {
"default": false,
"type": "boolean",
"description": "Gets the enabled attribute of the GenericScheduleDTO object."
},
"times": {
"items": {
"$ref": "#/definitions/GenericScheduledTimeDTO"
},
"type": "array",
"description": "Gets the times attribute of the GenericScheduleDTO object."
},
"occurrenceType": {
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY"
],
"type": "string",
"description": "Gets the occurrenceType attribute of the GenericScheduleDTO object."
},
"type": {
"enum": [
"LDAP",
"IMPORTER",
"RETENTION_POLICY"
],
"type": "string",
"description": "Gets the type attribute of the GenericScheduleDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the GenericScheduleDTO object."
}
}
},
"An object that holds values needed to render a chart on a dashboard.": {
"type": "object",
"properties": {
"chartOutputs": {
"items": {
"$ref": "#/definitions/An extension of KeyValuePair that supplies a type field."
},
"type": "array",
"description": "The values gathered from the output of the current chart based on where the user clicked."
},
"parentInputs": {
"items": {
"$ref": "#/definitions/A simple name-value pair used to pass data in a generic format."
},
"type": "array",
"description": "The values of the inputs to the parent chart."
},
"dashboardInputs": {
"items": {
"$ref": "#/definitions/A simple name-value pair used to pass data in a generic format."
},
"type": "array",
"description": "The values of all dashboard inputs."
}
}
},
"UserViewerSetting": {
"required": [
"docTypeMetadata",
"rotationAngle",
"user",
"zoomFactor"
],
"type": "object",
"properties": {
"xcoordinate": {
"type": "integer",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"ycoordinate": {
"type": "integer",
"format": "int32"
},
"zoomFactor": {
"type": "number",
"format": "float"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"rotationAngle": {
"type": "integer",
"format": "int32"
},
"user": {
"$ref": "#/definitions/User"
},
"docTypeMetadata": {
"$ref": "#/definitions/DocumentTypeMetadata"
},
"id": {
"type": "string"
}
}
},
"SQLException": {
"type": "object",
"properties": {
"stackTrace": {
"items": {
"$ref": "#/definitions/StackTraceElement"
},
"type": "array"
},
"suppressed": {
"items": {
"$ref": "#/definitions/Throwable"
},
"type": "array"
},
"nextException": {
"$ref": "#/definitions/SQLException"
},
"localizedMessage": {
"type": "string"
},
"errorCode": {
"type": "integer",
"format": "int32"
},
"sqlstate": {
"type": "string"
},
"message": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/Throwable"
}
}
},
"Information about groups pulled from an LDAP server.": {
"type": "object",
"properties": {
"lastPulled": {
"type": "string",
"description": "Date that information was last added or updated from the LDAP server.",
"format": "date-time"
},
"groupName": {
"type": "string",
"description": "Name of the group, as stored in LDAP."
},
"objectGuid": {
"type": "string",
"description": "Globally unique LDAP identifier of the group."
},
"modifiedTimestamp": {
"type": "integer",
"format": "int64"
},
"synchronize": {
"default": false,
"type": "boolean",
"description": "If true, use this information to make a DocFinity group."
}
}
},
"The email configuration settings for the system.": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the configured email account."
},
"tls": {
"default": false,
"type": "boolean",
"description": "The flag indicating the configuration of the TLS setting."
},
"authenticate": {
"default": false,
"type": "boolean",
"description": "The authentication setting of the configured email server."
},
"generatePasswordForceChangeFirst": {
"type": "string",
"description": "The introduction of the email that indicates the user is forced to change their password."
},
"generatePasswordIntroTwo": {
"type": "string",
"description": "The second part of the text of the introduction to the generate password email."
},
"forgotPasswordIntro": {
"type": "string",
"description": "The introduction to the forgot password email."
},
"passwordUsername": {
"type": "string",
"description": "The username for the recipient of the password email."
},
"passwordPassword": {
"type": "string",
"description": "The new password for the password email."
},
"passwordSubject": {
"type": "string",
"description": "The subject of the password email."
},
"generatePasswordOptionalNext": {
"type": "string",
"description": "The second portion of the optional generate password email."
},
"generatePasswordOptionalFirst": {
"type": "string",
"description": "The first part of the optional generate password email."
},
"host": {
"type": "string",
"description": "The email server host."
},
"forgotPasswordEnd": {
"type": "string",
"description": "The ending text of the forgot password email."
},
"generatePasswordIntroOne": {
"type": "string",
"description": "The introduction to the generate password email."
},
"generatePasswordForceChangeNext": {
"type": "string",
"description": "The main text area of the email that indicates the user is forced to change their password."
},
"generatePasswordSubject": {
"type": "string",
"description": "The subject line of the generate password email."
},
"password": {
"type": "string",
"description": "The password of the configured email account."
},
"port": {
"type": "integer",
"description": "The port of the configured email server.",
"format": "int32"
},
"maxAttachmentSize": {
"type": "integer",
"description": "The maximum size of attachments allowed to be attached to outgoing emails.",
"format": "int64"
}
}
},
"An object that assigns document security to a group.": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "string",
"description": "The document type ID to work with."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"documentSecurityDtos": {
"items": {
"$ref": "#/definitions/An object representing one specific security permission for a document type and group."
},
"type": "array",
"description": "The document security configuration for this document type."
}
}
},
"A switch prompt.": {
"allOf": [
{
"$ref": "#/definitions/A user prompt input."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"defaultChecked": {
"default": false,
"type": "boolean",
"description": "Whether the switch is on by default."
},
"macroValue": {
"type": "string"
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"label": {
"type": "string",
"description": "The prompt label."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"strDefaultValue": {
"type": "string"
},
"labelTrue": {
"type": "string",
"description": "The label for the true/on option."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"labelFalse": {
"type": "string",
"description": "The label for the false/off option."
},
"value": {
"type": "object"
},
"promptType": {
"enum": [
"SWITCH",
"DATE",
"TEXT",
"DROP_DOWN_LIST"
],
"type": "string",
"description": "The prompt type."
}
}
}
]
},
"An extension of KeyValuePair that supplies a type field.": {
"type": "object",
"properties": {
"dataType": {
"enum": [
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING"
],
"type": "string",
"description": "The data type of the property."
},
"dataValue": {
"type": "object"
},
"type": {
"enum": [
"X_VALUE",
"Y_VALUE",
"R_VALUE",
"SERIES_NAME",
"TEXT_LABEL",
"TEXT_VALUE",
"CELL_VALUE",
"COLUMN_HEADER",
"NAMED_COLUMN_VALUE"
],
"type": "string",
"description": "The type of drill down property in use."
},
"value": {
"type": "object",
"description": "The current value of the property in its raw data type."
},
"key": {
"type": "string",
"description": "The name or key of the property."
}
}
},
"FormAction": {
"required": [
"event",
"ordinal",
"type"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"properties": {
"items": {
"$ref": "#/definitions/FormActionProperty"
},
"type": "array"
},
"description": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"formControlStep": {
"$ref": "#/definitions/FormControlStep"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"condition": {
"type": "string"
}
}
},
"The representation of the search parameter prompt.": {
"type": "object",
"properties": {
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The type of the attribute associated with parameter prompt."
},
"id": {
"type": "string",
"description": "The ID of the prompt object."
},
"inputType": {
"enum": [
"CHECKBOX",
"SWITCH",
"DATE_FIELD",
"LIST",
"TEXT_FIELD",
"READ_ONLY",
"TEXT_AREA",
"AUTO_COMPLETE"
],
"type": "string",
"description": "The type of user prompt."
},
"label": {
"type": "string",
"description": "The prompt label."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by the prompt."
},
"editable": {
"default": false,
"type": "boolean",
"description": "Whether the prompt is editable."
},
"allowMultipleValues": {
"default": false,
"type": "boolean",
"description": "The indication whether or not this parameter prompt will accept multiple values."
},
"macroString": {
"type": "string",
"description": "The macro string used by the prompt."
},
"ordinal": {
"type": "integer",
"description": "The ordinal of the prompt.",
"format": "int32"
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The dependency mapping for the prompt."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type of the prompt."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute associated with this parameter prompt."
},
"strDefaultValue": {
"type": "string",
"description": "The default value of the prompt in string form."
},
"autoCompleteEndpoint": {
"type": "string",
"description": "The endpoint to use when requesting data in the auto complete control."
},
"maxLength": {
"type": "integer",
"description": "The maximum length of the prompt value.",
"format": "int32"
},
"data": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The data values to use in the prompt, useful for lists."
},
"hidden": {
"default": false,
"type": "boolean",
"description": "Whether the prompt is hidden."
},
"labelTrue": {
"type": "string",
"description": "The true label for switch prompts."
},
"name": {
"type": "string",
"description": "The prompt name."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The prompt type."
},
"required": {
"default": false,
"type": "boolean",
"description": "Whether the prompt is required."
},
"labelFalse": {
"type": "string",
"description": "The false label for switch prompts."
},
"parameterPromptDatasourceArguments": {
"items": {
"$ref": "#/definitions/ParameterPromptDatasourceArgDTO"
},
"type": "array",
"description": "The datasource arguments used for the prompt's datasource."
},
"autoCompleteMinLength": {
"type": "integer",
"description": "The minimum number of characters to type in the auto complete control before it filters.",
"format": "int32"
},
"autoCompleteTextField": {
"type": "string",
"description": "The field to display in the auto complete control."
},
"placeholderValue": {
"type": "string",
"description": "The placeholder value to show in the prompt."
}
}
},
"FormDocument": {
"type": "object",
"properties": {
"document": {
"$ref": "#/definitions/Document"
},
"id": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"formInstance": {
"$ref": "#/definitions/FormInstance"
}
}
},
"View prompt configuration information.": {
"type": "object",
"properties": {
"displayLabel": {
"type": "string",
"description": "View prompt display label."
},
"ordinal": {
"type": "integer",
"description": "View prompt ordinal.",
"format": "int32"
},
"viewPromptResult": {
"description": "View prompt result dto.",
"$ref": "#/definitions/ViewPromptResultDTO"
},
"datasourceName": {
"type": "string",
"description": "View prompt datasource name."
},
"name": {
"type": "string",
"description": "View prompt name."
},
"defaultValueType": {
"enum": [
"NONE",
"STATIC",
"USE_DATASOURCE"
],
"type": "string",
"description": "View prompt default value type."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"NUMBER"
],
"type": "string",
"description": "View prompt data type."
},
"prePopulateValues": {
"items": {
"$ref": "#/definitions/Configuration informaton to send a value through webservices."
},
"type": "array",
"description": "Pre-populated values for the view prompts."
},
"defaultValue": {
"type": "string",
"description": "View prompt default value."
},
"datasourceId": {
"type": "string",
"description": "View prompt datasource id."
},
"fieldType": {
"enum": [
"TEXT",
"LIST"
],
"type": "string",
"description": "View prompt field type."
},
"validatorDisplayDtos": {
"items": {
"$ref": "#/definitions/The validator associated with the view prompt."
},
"type": "array",
"description": "View prompt validator display dtos."
},
"id": {
"type": "string",
"description": "View prompt id."
}
}
},
"View column configuration data": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "View column ordinal information.",
"format": "int32"
},
"columnType": {
"enum": [
"JOB_PROPERTY",
"PROCESS_INSTANCE_VARIABLE",
"PACKAGE_ITEM_PROPERTY"
],
"type": "string",
"description": "View column type information."
},
"columnDisplayValue": {
"type": "string",
"description": "View column display value information."
},
"columnDataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "View column data type information."
},
"columnTypeProperty": {
"type": "string",
"description": "View column type property information."
},
"columnVariable": {
"type": "string",
"description": "View column variable information."
},
"id": {
"type": "string",
"description": "View column id information."
}
}
},
"An object that represents an email item that contains one or more clipboard documents.": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "The email body."
},
"from": {
"type": "string",
"description": "The from field."
},
"cc": {
"type": "string",
"description": "The CC field."
},
"bcc": {
"type": "string",
"description": "The BCC field."
},
"to": {
"type": "string",
"description": "The to address field."
},
"documentIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "One or more document IDs that were attached to the email."
},
"subject": {
"type": "string",
"description": "The subject field."
}
}
},
"An object defining the information needed to render a chart on a dashboard.": {
"type": "object",
"properties": {
"title": {
"description": "The chart title definition.",
"$ref": "#/definitions/An object that defines the title of a chart."
},
"type": {
"enum": [
"AREA",
"BAR",
"LINE",
"MIXED",
"PIE",
"GAUGE",
"TEXT",
"TABLE"
],
"type": "string",
"description": "The chart type."
},
"rendering": {
"description": "The JSON rendering of the chart.",
"$ref": "#/definitions/RenderedChart"
},
"drillDown": {
"description": "The next level of drill down where this chart can go.",
"$ref": "#/definitions/A transition from a chart to another object: a chart, dashboard, or URL."
},
"border": {
"description": "The chart border definition.",
"$ref": "#/definitions/An object that defines the border for a chart."
},
"parentChartInputs": {
"items": {
"$ref": "#/definitions/A simple name-value pair used to pass data in a generic format."
},
"type": "array",
"description": "The inputs that were given to this chart when rendering. Used when drilling down to the next level."
}
}
},
"Database column information used by datastores.": {
"required": [
"name",
"type"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal flag to indicate the ordinal of the datastore column object.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string",
"description": "The name of the database column used by the datastore."
},
"nullable": {
"default": false,
"type": "boolean",
"description": "The boolean flag to indicate if database column used by datastore is nullable."
},
"dataType": {
"type": "string",
"description": "The string representation of type."
},
"autoIncrement": {
"default": false,
"type": "boolean",
"description": "The auto increment key flag to indicate if database column used by datastore is to be auto incremented."
},
"id": {
"type": "string",
"description": "The ID of the datastore column configuration data."
},
"useInUpdate": {
"default": false,
"type": "boolean",
"description": "The use in update flag to indicate that the database column must be used in an update clause by the datastore."
},
"type": {
"type": "integer",
"description": "The type of the database column used by the datastore.",
"format": "int32"
},
"useInWhereClause": {
"default": false,
"type": "boolean",
"description": "The use in where clause flag to indicate if database column used by datastore is part of a where clause."
},
"useInInsert": {
"default": false,
"type": "boolean",
"description": "The use in insert flag to indicate that the database column must be used in an insert clause by the datastore."
},
"primaryKey": {
"default": false,
"type": "boolean",
"description": "The primary key flag to indicate if database column used by datastore is the primary key."
}
}
},
"DTO object for a Form Step.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "Gets the ordinal attribute of the FormStepDTO object.",
"format": "int32"
},
"deleted": {
"default": false,
"type": "boolean"
},
"formId": {
"type": "string",
"description": "Gets the formId attribute of the FormStepDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the FormStepDTO object."
},
"name": {
"type": "string",
"description": "Gets the name attribute of the FormStepDTO object."
}
}
},
"ParameterDTO": {
"type": "object",
"properties": {
"dataType": {
"type": "string"
},
"supportedInputDataType": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"Dto object that populates the initial form monitoring screen.": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Gets the status attribute of the FormMonitoringDTO object."
},
"numInstances": {
"type": "integer",
"description": "Gets the numInstances attribute of the FormMonitoringDTO object.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the name attribute of the FormMonitoringDTO object."
},
"version": {
"type": "integer",
"description": "Gets the version attribute of the FormMonitoringDTO object.",
"format": "int32"
},
"checkedOutBy": {
"type": "string",
"description": "Gets the checkedOutBy attribute of the FormMonitoringDTO object."
},
"id": {
"type": "string",
"description": "Gets the id attribute of the FormMonitoringDTO object."
}
}
},
"An object representing a security filter used in document security.": {
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal of this filter in the list for this permission type.",
"format": "int32"
},
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "The connective type used when evaluating the filter."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"numericValue": {
"type": "integer",
"description": "The integer value to use in the filter.",
"format": "int32"
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string",
"description": "The comparator type used when evaluating the filter."
},
"metadataName": {
"type": "string",
"description": "The name of the metadata object that this filter checks against."
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string",
"description": "The type of the metadata object that this filter checks against."
},
"strValue": {
"type": "string",
"description": "The string value to use in the filter."
},
"metadataId": {
"type": "string",
"description": "The ID of the metadata object that this filter checks against."
},
"dateValue": {
"type": "string",
"description": "The date value to use in the filter.",
"format": "date-time"
},
"decimalValue": {
"type": "number",
"description": "The decimal value to use in the filter.",
"format": "double"
},
"id": {
"type": "string",
"description": "The unique identifier of this filter."
}
}
},
"An object that holds general properties for the chart.": {
"type": "object",
"properties": {
"stacked": {
"default": false,
"type": "boolean",
"description": "Whether the chart data should be stacked."
},
"orientation": {
"enum": [
"HORIZONTAL",
"VERTICAL"
],
"type": "string",
"description": "The chart orientation."
},
"format": {
"description": "The chart format properties.",
"$ref": "#/definitions/An object that holds the format properties for a chart."
},
"labelConnected": {
"default": false,
"type": "boolean",
"description": "Whether the labels should be connected to the chart."
},
"sortDirection": {
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "The sort direction"
},
"sortable": {
"default": false,
"type": "boolean",
"description": "Whether the chart is sortable."
},
"animate": {
"default": false,
"type": "boolean",
"description": "Whether to animate when drawing the chart."
},
"border": {
"description": "The chart border configuration.",
"$ref": "#/definitions/An object that defines the border for a chart."
},
"spline": {
"default": false,
"type": "boolean",
"description": "Whether the chart's line should be a spline."
}
}
},
"GlobalSessionDTO": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"licensableModuleId": {
"type": "integer",
"format": "int64"
},
"revoked": {
"default": false,
"type": "boolean"
},
"firstName": {
"type": "string"
},
"licensePoolName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"userId": {
"type": "string"
},
"licensePoolId": {
"type": "string"
},
"deviceType": {
"enum": [
"MOBILE",
"TABLET",
"NORMAL"
],
"type": "string"
},
"deviceId": {
"type": "string"
},
"clientKey": {
"type": "string"
},
"lastAccess": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
}
}
},
"A hidden datasource input.": {
"allOf": [
{
"$ref": "#/definitions/An input to a dashboard."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"value": {
"type": "object"
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"An object representing the assignment of a dashboard to a group.": {
"required": [
"dashboardId",
"groupId"
],
"type": "object",
"properties": {
"dashboardId": {
"type": "string",
"description": "The dashboard ID."
},
"groupName": {
"type": "string",
"description": "The group name."
},
"dashboardName": {
"type": "string",
"description": "The dashboard name."
},
"id": {
"type": "string",
"description": "The ID of the DashboardGroup."
},
"groupId": {
"type": "string",
"description": "The group ID"
}
}
},
"SearchSortOrder": {
"required": [
"attributeName",
"attributeType",
"name",
"orderType",
"ordinal",
"search"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"format": "int32"
},
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"customValues": {
"items": {
"$ref": "#/definitions/SearchSortOrderCustom"
},
"type": "array"
},
"orderType": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string"
},
"attributeName": {
"type": "string"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"attributeId": {
"type": "string"
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string"
},
"id": {
"type": "string"
},
"metadata": {
"$ref": "#/definitions/Metadata"
}
}
},
"LegalHoldCustodian": {
"required": [
"legalHoldCase",
"user"
],
"type": "object",
"properties": {
"deleted": {
"default": false,
"type": "boolean"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"legalHoldCase": {
"$ref": "#/definitions/LegalHoldCase"
},
"user": {
"$ref": "#/definitions/User"
},
"newObject": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
}
}
},
"EditQueuePageDTO": {
"type": "object",
"properties": {
"sourcePageNumber": {
"type": "integer",
"format": "int32"
},
"editLockId": {
"type": "string"
},
"newPageNumber": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"rotationAngle": {
"type": "integer",
"format": "int32"
},
"sourceDocumentId": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"The representation of the hsm search preview dto object.": {
"type": "object",
"properties": {
"searchId": {
"type": "string",
"description": "The search id to use."
},
"maxNum": {
"type": "integer",
"description": "The maximum number of the results to return.",
"format": "int32"
},
"hsmId": {
"type": "string",
"description": "The hsm id to use."
},
"startIndex": {
"type": "integer",
"description": "The start index of the results.",
"format": "int32"
},
"searchSortOrders": {
"items": {
"$ref": "#/definitions/The representation of the sorting to apply to the search results."
},
"type": "array",
"description": "The sort orders to use."
},
"metadataValueCriteria": {
"items": {
"$ref": "#/definitions/MetadataValueCriteria"
},
"type": "array",
"description": "The metadata value criteria to use."
}
}
},
"DocumentTypeScanSetting": {
"required": [
"documentType",
"scanSetting"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"documentTypeId": {
"type": "string"
},
"id": {
"type": "string"
},
"scanSetting": {
"$ref": "#/definitions/ScanSetting"
},
"documentType": {
"$ref": "#/definitions/DocumentType"
}
}
},
"SearchStoredProcedure": {
"required": [
"name",
"search"
],
"type": "object",
"properties": {
"search": {
"$ref": "#/definitions/Search"
},
"markedForDelete": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"databaseConnection": {
"$ref": "#/definitions/DatabaseConnection"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"searchStoredProcedureParameters": {
"items": {
"$ref": "#/definitions/SearchStoredProcedureParameter"
},
"type": "array"
},
"id": {
"type": "string"
},
"schema": {
"type": "string"
}
}
},
"ViewPromptResultDTO": {
"type": "object",
"properties": {
"stringValue": {
"type": "string"
},
"numericValue": {
"type": "number",
"format": "double"
},
"name": {
"type": "string"
},
"dateValue": {
"type": "integer",
"format": "int64"
}
}
},
"The configuration for a chart's X or Y axis.": {
"type": "object",
"properties": {
"labelRotation": {
"type": "integer",
"description": "The axis label rotation.",
"format": "int32"
},
"format": {
"description": "The format for the axis label.",
"$ref": "#/definitions/An object that holds the format properties for a chart."
},
"precision": {
"type": "integer",
"description": "The scale precision.",
"format": "int32"
},
"label": {
"type": "string",
"description": "The axis label."
},
"visible": {
"default": false,
"type": "boolean",
"description": "Whether the axis is visible."
},
"titleRotation": {
"type": "integer",
"description": "The axis title rotation.",
"format": "int32"
},
"minorTicks": {
"default": false,
"type": "boolean",
"description": "Whether to show minor axis ticks."
},
"majorStep": {
"type": "integer",
"description": "The major step interval.",
"format": "int32"
},
"labelStep": {
"type": "integer",
"description": "How many steps between labels.",
"format": "int32"
}
}
},
"ContentDisposition": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"parameters": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
}
},
"ComparableObject": {
"type": "object"
},
"Auditing data used to configure auditing levels for individual process models.": {
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"default": false,
"type": "boolean",
"description": "The boolean flag indicating if the auditing event type is configured to record an audit or not."
},
"name": {
"type": "string",
"description": "The name of the process model."
}
}
},
"An object containing a chart's scale configuration.": {
"type": "object",
"properties": {
"y": {
"description": "The Y axis configuration.",
"$ref": "#/definitions/The configuration for a chart's X or Y axis."
},
"x": {
"description": "The X axis configuration.",
"$ref": "#/definitions/The configuration for a chart's X or Y axis."
},
"r": {
"description": "The R scale configuration.",
"$ref": "#/definitions/The confiuration for the R axis for a chart."
}
}
},
"An object containing the information needed in order to execute a macro.": {
"type": "object",
"properties": {
"macro": {
"type": "string",
"description": "The macro to execute."
},
"arguments": {
"items": {
"$ref": "#/definitions/An argument to be sent to a datasource."
},
"type": "array",
"description": "The arguments to send while executing the macro."
}
}
},
"A drop down list prompt.": {
"allOf": [
{
"$ref": "#/definitions/A user prompt input that allows a datasource and is required."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"prompt": {
"type": "string",
"description": "The prompt value, used when defaultValueType is PROMPT."
},
"macroValue": {
"type": "string"
},
"isEditable": {
"default": false,
"type": "boolean",
"description": "Whether the list is editable."
},
"specificValue": {
"type": "string",
"description": "The specific default value, used when defaultValueType is SPECIFIC."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"label": {
"type": "string",
"description": "The prompt label."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"defaultValueType": {
"enum": [
"STATIC",
"MACRO",
"DATASOURCE",
"FIRST",
"SPECIFIC",
"PROMPT"
],
"type": "string",
"description": "The default value type."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"required": {
"default": false,
"type": "boolean",
"description": "Whether the input is required."
},
"value": {
"type": "object"
},
"promptType": {
"enum": [
"SWITCH",
"DATE",
"TEXT",
"DROP_DOWN_LIST"
],
"type": "string",
"description": "The prompt type."
}
}
}
]
},
"ProcessModelPackageItemDTO": {
"type": "object",
"properties": {
"packageItemType": {
"type": "string"
},
"description": {
"type": "string"
},
"deleted": {
"default": false,
"type": "boolean"
},
"required": {
"default": false,
"type": "boolean"
},
"packageItemName": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"The representation of the parameter objects associated with a search.": {
"type": "object",
"properties": {
"searchPromptId": {
"type": "string",
"description": "The ID of the search prompt used in the execution of this parameter. This is the unique identifier of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL."
},
"numericValue": {
"type": "integer",
"description": "The numeric value of the parameter, when the parameter is a INTEGER data type. If the data type of the parameter is not a integer, this value should be NULL.",
"format": "int32"
},
"closingParen": {
"type": "string",
"description": "The representation of closing parenthesis that will end groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL."
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "The indication as to whether or not to delete this parameter from the search."
},
"attributeType": {
"enum": [
"CATEGORY",
"DOCUMENT_TYPE",
"FULL_TEXT",
"DIARY",
"METADATA",
"OTHER",
"STORED_PROC_PARAM",
"STORED_PROC_COLUMN",
"DOCUMENT_ATTRIBUTES",
"FILE_ATTRIBUTES",
"DOCUMENT_VARIABLES",
"FILE_TYPE",
"HIDDEN",
"HIDDEN_DATE",
"HIDDEN_INTEGER",
"HIDDEN_DECIMAL"
],
"type": "string",
"description": "The type of the attribute used by the parameter."
},
"decimalValue": {
"type": "number",
"description": "The decimal value of the parameter, when the parameter is a DECIMAL data type. If the data type of the parameter is not a decimal, this value should be NULL.",
"format": "double"
},
"id": {
"type": "string",
"description": "The ID of the parameter associated with the search."
},
"searchPromptName": {
"type": "string",
"description": "The name of the search prompt used in the execution of this parameter. This is the unique identifier (with a particular search) of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL."
},
"sortOrder": {
"enum": [
"ASC",
"DESC",
"CUSTOM"
],
"type": "string",
"description": "The sort order associated with this parameter. NOTE: This value is no longer used because of SearchSortOrder."
},
"attributeId": {
"type": "string",
"description": "The ID of the attribute (data) associated with this parameter. If the data is non-metadata, then this ID will be NULL."
},
"type": {
"enum": [
"PROMPTED",
"STATIC",
"MACRO",
"CUSTOM"
],
"type": "string",
"description": "The type of the parameter, indicating what needs to be associated to the parameter. Static static parameter will associate a static value with the parameter. A prompted parameter will require input from a user prompt. A custom parameter will require input from multiple sources to do a sub-select query from other tables to retrieve values to use in the search."
},
"ordinal": {
"type": "integer",
"description": "The ordinal of this parameter with respect to other parameters in the search.",
"format": "int32"
},
"metadataType": {
"enum": [
"DATE",
"INTEGER",
"DECIMAL",
"STRING_VARIABLE"
],
"type": "string",
"description": "The type of the metadata associated with this parameter. If the parameter is not associated to metadata, then this field will be NULL."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute (data) associated with this parameter."
},
"openingParen": {
"type": "string",
"description": "The representation of opening parenthesis that will begin groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL."
},
"dateValue": {
"type": "string",
"description": "The date value of the parameter, when the parameter is a DATE data type. If the data type of the parameter is not a date, this value should be NULL.",
"format": "date-time"
},
"valueRequired": {
"default": false,
"type": "boolean"
},
"promptLabel": {
"type": "string"
},
"connectiveType": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "The connector that is used to connect this parameter and the parameter that occurs directly before this parameter when ordered by their parameter ordinal values within the search."
},
"comparatorType": {
"enum": [
"EQUALS",
"NOT_EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"LESS_THAN_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"IN"
],
"type": "string",
"description": "The comparator operator used in the execution and resolution of this parameter."
},
"lookupList": {
"default": false,
"type": "boolean"
},
"strValue": {
"type": "string",
"description": "The string value of the parameter, when the parameter is a STRING data type. If the data type of the parameter is not a string, this value should be NULL."
}
}
},
"DatasourceProperty": {
"required": [
"datasource",
"displayName",
"displayValue",
"name",
"value"
],
"type": "object",
"properties": {
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
},
"datasource": {
"$ref": "#/definitions/Datasource"
},
"displayValue": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"A text prompt.": {
"allOf": [
{
"$ref": "#/definitions/A user prompt input that allows a datasource and is required."
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"ordinal": {
"type": "integer",
"description": "The ordinal.",
"format": "int32"
},
"markedForDelete": {
"default": false,
"type": "boolean",
"description": "Whether this item should be deleted."
},
"datasourceName": {
"type": "string",
"description": "The name of the datasource used by this input."
},
"name": {
"type": "string",
"description": "The input name, must be unique per dashboard."
},
"dashboardInputDatasourceInputs": {
"items": {
"$ref": "#/definitions/DashboardInputDatasourceInputDTO"
},
"type": "array",
"description": "The inputs needed for the datasource for this input."
},
"parameterPromptDto": {
"$ref": "#/definitions/A generic representation of a user prompt."
},
"dashboardName": {
"type": "string",
"description": "The name of the dashboard that owns this input."
},
"promptType": {
"enum": [
"SWITCH",
"DATE",
"TEXT",
"DROP_DOWN_LIST"
],
"type": "string",
"description": "The prompt type."
},
"defaultValue": {
"type": "string",
"description": "The default static text or macro."
},
"required": {
"default": false,
"type": "boolean",
"description": "Whether the input is required."
},
"value": {
"type": "object"
},
"label": {
"type": "string",
"description": "The prompt label."
},
"macroValue": {
"type": "string"
},
"dataType": {
"enum": [
"STRING",
"DATE",
"DECIMAL",
"INTEGER",
"BOOLEAN",
"STRING_ARRAY",
"DATE_ARRAY",
"DECIMAL_ARRAY",
"INTEGER_ARRAY",
"BOOLEAN_ARRAY"
],
"type": "string",
"description": "The data type."
},
"datasourceId": {
"type": "string",
"description": "The ID of the datasource used by this input."
},
"datasourceResults": {
"items": {
"$ref": "#/definitions/Data value used to represent a generic key value pair."
},
"type": "array",
"description": "The results from executing the datasource."
},
"dashboardId": {
"type": "string",
"description": "The ID of the dashboard that owns this input."
},
"type": {
"enum": [
"DATASOURCE",
"STATIC",
"MACRO",
"DASHBOARD_PROMPT"
],
"type": "string",
"description": "The type of input."
},
"id": {
"type": "string",
"description": "The ID of the DashboardInput."
},
"defaultValueType": {
"enum": [
"STATIC",
"MACRO",
"DATASOURCE",
"FIRST",
"SPECIFIC",
"PROMPT"
],
"type": "string",
"description": "The default value type."
},
"responsibilityMapping": {
"items": {
"type": "string"
},
"type": "array",
"description": "The responsibility mapping for executing dependent inputs."
}
}
}
]
},
"A role used in business process management.": {
"type": "object",
"properties": {
"roleHolder": {
"type": "string",
"description": "Username of the role holder (display only)."
},
"roleHolderFirstName": {
"type": "string",
"description": "First name of the role holder (display only.)"
},
"roleHolderLastName": {
"type": "string",
"description": "Last name of the role holder (display only)."
},
"actors": {
"items": {
"$ref": "#/definitions/A user who is assigned to a specific order in a role."
},
"type": "array",
"description": "The users who are assigned to this role."
},
"roleName": {
"type": "string",
"description": "The name of the role."
},
"id": {
"type": "string",
"description": "The ID of the role."
}
}
},
"PrintFaxServer": {
"required": [
"isSecureHttp",
"port",
"serverName",
"serverType"
],
"type": "object",
"properties": {
"serverName": {
"type": "string"
},
"serverType": {
"enum": [
"PRINTER",
"FAX"
],
"type": "string"
},
"devices": {
"items": {
"$ref": "#/definitions/PrintFaxDevice"
},
"type": "array"
},
"port": {
"type": "integer",
"format": "int32"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"isSecureHttp": {
"default": false,
"type": "boolean"
},
"id": {
"type": "string"
}
}
},
"ValidatorProperty": {
"required": [
"name"
],
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"validator": {
"$ref": "#/definitions/Validator"
},
"validationFields": {
"items": {
"type": "string"
},
"type": "array"
},
"displayValue": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"A data transfer object representing a form design.": {
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"INACTIVE_STILL_RUNNING",
"DELETED"
],
"type": "string",
"description": "Gets the status attribute of the FormDTO object."
},
"styles": {
"type": "string",
"description": "Gets the styles attribute of the FormDTO object."
},
"allowAnonymousAccessToView": {
"default": false,
"type": "boolean"
},
"currentStepId": {
"type": "string",
"description": "Gets the currentStepId attribute of the FormDTO object."
},
"formControls": {
"items": {
"$ref": "#/definitions/DTO object for a FormControl."
},
"type": "array",
"description": "Gets the formControls attribute of the FormDTO object."
},
"description": {
"type": "string",
"description": "Gets the description attribute of the FormDTO object."
},
"allowAnonymousAccessToEdit": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string",
"description": "Gets the name attribute of the FormDTO object."
},
"width": {
"type": "integer",
"description": "Gets the width attrib
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment