ServerVersionInfo
version: string
buildDate: string
buildTimeStamp: long
ErrorCodeInfo
errorCode: integer
current codes:
0 OK
1000 not implemented
1001 output document error
1002 delete document error
1003 create user error
1004 delete user error
1005 enroll card error
1006 account not found
1007 object tree error
1008 create account error
1009 create output port error
1010 create trigger error
1011 delete trigger error
1012 run automation error
1013 update user error
1014 register server error
1015 create input port error
1016 delete input port error
1017 delete output port error
1030 delete authentication provider error
1031 save authentication provider error
1032 no services for authentication provider error
1040 save access control error
1041 delete access control error
1042 output not ready error
1043 create group error
1044 delete group error
1050 license count exceeded
1051 license expired
1060 import users error
1070 create terminal configuration error
1080 delete account error
1090 update account error
10000 unknown error
ErrorCodeInfoId
errorCode: integer
id: integer
current codes: same as for ErrorCodeInfo
UserInfo
id: int
providerId: int
accountId: int
userName: string
fullName: string
email: string
department: string
shortId: string
cards: list of strings
createdDate: string // in ISO-8601 format
token: TokenInfo // optional, may be null
isExpired: boolean // optional, may be null, this field is filled only for users belonging to authentication providers of type Client.
groupIds: list of int
TokenInfo
access_token: string
refresh_token: string
expires_in: int
DocumentInfo
uuid: string
documentName: string
documentType: int
userName: string
totalPages: int
colorPages: int
duplex: int
copies: int
grayscale: boolean
paperSize: string
dateTime: long
storageOnline: boolean
secure: boolean
tags: list of TagInfo
collate: boolean
status: int (0 => READY,1 => PRINTED, 2 => DELETED, 3 => EXPIRED, 4 => FAILED, 5 => RECEIVED, 6 => AWAITING_CONVERSION, 7 => CONVERTING, 8 => CONVERSION_FAILED, 9 => STORED)
outputPortId: int
outputPortName: string
jobType: string (PRINT, COPY, SCAN, FAX)
Document Status Flowchart
OutputPortInfo
id: int
name: string
address: string
portType: int
vendor: string
logoutTimeout: int
autoRelease: boolean
embedded: boolean
monochrome: boolean
trimCardId: boolean
description: string
embeddedConfigurationId: int
printProtocol: int
modelFamily: int
outputType: int
services: {
string: [int, int, ...],
...
}
deviceSerial: string
properties: {
string: string,
...
}
containerName: string,
accountId: int,
parentAccountOrContainerId: int,
decimalFormatForCardIds: boolean,
isReverseFinisher: boolean,
printerIppUrl: string,
ipReaderAddress: string,
softwareCopyCollation: boolean,
sendUsername: boolean,
registrationSource: string, // "manual", "autodiscovery"
terminalInfo: {
deployStatus (optional, may be null): {
stage: int (0 => NOT_INSTALLED, 1 => INSTALLED, 2 => INSTALLING, 3 => UNINSTALLING, 4 => CONFIGURING, 5 => CONFIGURED, 6 => FAILED, 7 => CLOUD_UNKNOWN, 8 => CLOUD_CONFIGURED),
message: string,
lastDate: string
},
terminalStatus (optional, may be null): {
terminalVersion: string,
installationSource: int (0 => UNKNOWN, 1 => MANUAL, 2 => KM_MARKETPLACE, 3 => RICOH_APPLICATION_SITE, 4 => HP_COMMAND_CENTER),
cardReaderData: string,
modelName: string,
additionalModelInfo: string,
firmwareVersion: string,
status: int (0 => UNKNOWN, 1 => OK, 2 => WARNING, 3 => ERROR),
statusMessage: string,
errorData: string,
modifiedDate: string
}
}
InputPortInfo
id: int
name: string
portType: int
outputPort: string (optional, may be null)
locationId: int (optional, may be null)
containerName: string (optional, may be null)
AccountInfo
id: int
name: string
accountType: int (1=vendor, 2=customer, 3=container)
domainNames: list of strings
uuid: string
timezone: string (optional, may be null)
ContainerInfo
id: int
name: string
domainNames: list of strings
timezone: string (optional, may be null)
LocationInfo
id: int
name: string
sortOrder: int
identifiers: list of LocationIdentifierSearch
LocationIdentifierSearch
locationType: LocationType (GATEWAY_IP, SUBNET, IP_RANGE, WIFI_SSID)
searchValue: string
GroupInfo
id: int
groupName: string
groupDN: string
TerminalConfig
"services": {
"scanToMe": {
"serviceId": "SCANTOMAIL",
"enabled": boolean,
"instanceIndex": 1,
"smtp": {
"server": string,
"port": int,
"security": {
"mode": string, ("none", "tls", "start_tls")
"disableCertificateCheck": boolean
},
"user": string,
"password": string,
"senderEmail": string,
"disableUserAuthentication": boolean
}
},
"print": {
"serviceId": "PRINT",
"enabled": boolean,
"instanceIndex": 1
},
"printShortcut": {
"serviceId": "SHPMCPRINT",
"enabled": boolean
},
"sho365Shortcut": {
"serviceId": "SHO365",
"enabled": boolean,
"tenant": {
"tenantId": string,
"clientId": string
}
},
"copyShortcut": {
"serviceId": "STANDARDCOPY",
"enabled": boolean
},
"standardScanShortcut": {
"serviceId": "STANDARDSCAN",
"enabled": boolean
},
"standardFaxShortcut": {
"serviceId": "STANDARDFAX",
"enabled": boolean
}
},
"authentication-way": {
"oneTimePasswordEnrollment": boolean,
"cardOnlyAuthentication": boolean,
"shortIdAuthentication": boolean,
"developerLogEnabled": boolean
}
ScanConnectorInfo
"id": int,
"name": string, // max length 100
"description": string, // optional, max length 300
"connectorType": string, // EMAIL, ONEDRIVE_BUSINESS_OAUTH2, SHAREPOINT_ONLINE_OAUTH2, GOOGLE_DRIVE_OAUTH2 (only in preview), GENERIC_HTTPS (currently hidden by default), SCAN_TO_DOWNLOAD
"smtpConnectorParameters": { // optional, used only if connectorType is EMAIL
"messagingConfigId": int // optional, System default messaging config used when not provided
},
"sharePointConnectorParameters": { // optional, used only if connectorType is SHAREPOINT_ONLINE_OAUTH2
"siteName": string // optional, will be empty if not specified
},
"genericHttpsConnectorParameters": { // optional, used only if connectorType is GENERIC_HTTPS
"endpointUrl": string, // required, has to be valid HTTPS URL
"properties": { // optional, additional properties (key-value pairs) to be passed with the request (for example for custom authentication)
"auth_username": string, // the key has to be an unique string
"auth_password": string
}
},
"scanToDownloadConnectorParameters": { // optional, used only if connectorType is SCAN_TO_DOWNLOAD
"notificationEnabled": boolean, // optional, false by default
"messagingConfigId": int, // required if notificationEnabled is true
"templateConfigId": int // required if notificationEnabled is true
},
"retryAttemptsCount": int, // optional, default 0, range 0-99999
"retryAttemptsTimeout": int, // optional, number of seconds, default 3, range 0-120
"deliveryRestrictions": { // optional, may be null
"enabled": boolean, // optional, default false
"maxScanJobSize": int // required if enabled is 'true', otherwise not used, maximum scan job size in megabytes, range 1-999999
}
ScanWorkflowTemplateInfo
"id": int,
"name": string, // max length 100
"description": string, // optional, max length 300
"connectorId": int,
"scanOptions": { // optional, may be null
"resolution": string, // optional, LOW, NORMAL, FINE, HIGH, HIGHEST
"colorMode": string, // optional, AUTO, BLACK_AND_WHITE, FULL_COLOR, ONE_COLOR, TWO_COLOR, GRAY_SCALE
"pageSides": string, // optional, SIMPLEX, DUPLEX
"mergingOriginals": string, // optional, DISABLED, ENABLED
"resolutionEditableByUser": boolean, // optional, default false
"colorModeEditableByUser": boolean, // optional, default false
"pageSidesEditableByUser": boolean, // optional, default false
"mergingOriginalsEditableByUser": boolean // optional, default false
},
"ocrOptions": OcrProcessingStep, // optional, may be null
"barcodeOptions": BarcodeOptions, // optional, may be null
"documentSeparationOptions": DocumentSeparationOptions // optional, may be null
"highlightRedactionOptions": HighlightRedactionOptions // optional, may be null
"smtpConnector": { // optional, used only if connectorType is EMAIL
"mailTo": string,
"mailSubject": string,
"mailBody": string,
},
"sharePointConnector": { // optional, used only if connectorType is SHAREPOINT_ONLINE_OAUTH2
"rootPath": string,
"relativeTargetPath": string,
"overwriteBehavior": string, // KEEP_BOTH, REPLACE_ORIGINAL, APPEND_TO_PDF, PREPEND_TO_PDF
"columns": list<SharePointColumnsData>,
},
"oneDriveConnector": { // optional, used only if connectorType is ONEDRIVE_BUSINESS_OAUTH2
"relativeTargetPath": string,
"overwriteBehavior": string, // KEEP_BOTH, REPLACE_ORIGINAL, APPEND_TO_PDF, PREPEND_TO_PDF
},
"googleDriveConnector": { // optional, used only if connectorType is GOOGLE_DRIVE_OAUTH2
"relativeTargetPath": string,
"overwriteBehavior": string, // KEEP_BOTH, REPLACE_ORIGINAL, APPEND_TO_PDF, PREPEND_TO_PDF
},
"fileName": string, // optional, may be null
"fileType": string, // PDF, TIFF, JPEG
"sortOrder": string, // optional, default is last (e.g. 3 if this is 3rd workflow created)
"active": boolean, // optional, default true
"userInputs": list<UserInputInfo>, // optional, may be null,
"fileTypeEditableByUser": boolean // optional, default false, when OcrProcessingStep is enabled this is always false
ScanWorkflowAccessInfo
"id": int,
"workflowId": int, // optional, id of ScanWorkflowTemplateInfo
"workflowName": string, // optional, name of ScanWorkflowTemplateInfo
"identityId": int, // optional
"identityName": string // optional
"identityType": String, // optional, User or Group
"allowAccess": boolean // optional, default true
DocumentSeparationOptions
enabled": boolean, // Note: In a PUT request, if this field is set to false, the entire existing DocumentSeparationOptions is removed
"separationType": string, // BARCODE_TYPE, SEPARATION_SHEET, PAGE_COUNT
"separationBarcodeType": string, // only used when separationType is BARCODE_TYPE, values: UPC_A, UPC_E, EAN_8, EAN_13, CODE_39, CODE_93, CODE_128, CODABAR, ITF, RSS_14, RSS_EXPANDED, ALL_1D, AZTEC, DATA_MATRIX, MAXICODE, PDF_417, QR_CODE
"dropSeparator": boolean, // only used when separationType is BARCODE_TYPE or SEPARATION_SHEET, optional, may be null, BARCODE_TYPE default value false, SEPARATION_SHEET default value true
"pageSplitSize": string // only used when separationType is PAGE_COUNT, variable or a positive whole number
OcrProcessingStep
"enabled": boolean, // Note: In a PUT request, if this field is set to false, the entire existing OcrProcessingStep is removed
"blankPages": boolean,
"dualPages": boolean,
"pageOrientation": boolean,
"despeckle": boolean,
"languages": list<string>,
"outputFormatParameters": {
"pdfaCompliance": string, // PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_2U, PDF_A_3A, PDF_A_3U
"modifyMetadata": boolean,
"metaTitle": string,
"metaAuthor": string,
"metaSubject": string,
"metaKeywords": string,
"metaOverwriteUponChange": boolean,
"mrcCompression": boolean,
"encryptPdf": boolean,
"encryptionStrength": string, // RC40BIT, RC128BIT, AES128BIT
"encryptionPasswordType": string, // GeneratePassword, ManualPassword
"encryptionPassword": string, // only used when encryptionPasswordType is ManualPassword
"sendEmail": boolean,
"emailRecipients": string,
"emailSubject": string,
"emailBody": string
}
BarcodeOptions
"enabled": boolean, // Note: In a PUT request, if this field is set to false, the entire existing BarcodeOptions is removed
"barcodeType": string, // UPC_A, UPC_E, EAN_8, EAN_13, CODE_39, CODE_93, CODE_128, CODABAR, ITF, RSS_14, RSS_EXPANDED, ALL_1D, AZTEC, DATA_MATRIX, MAXICODE, PDF_417, QR_CODE
HighlightRedactionOptions
"enabled": boolean, // Note: In a PUT request, if this field is set to false, the entire existing HighlightRedactionOptions is removed
"highlightColor": string, // GREEN, RED
"redactionType": string, // WHOLE_DOCUMENT, RANGE
"rangeFrom": string, // optional, may be null. Only used in RANGE redaction type
"rangeTo": string, // optional, may be null. Only used in RANGE redaction type
SharePointColumnsData
string: string // first string is column name, second is column value
UserInputInfo
name: string,
label: string,
defaultValue: string, // optional, may be null
required: boolean, // optional, may be null
userInputType: string, // LIST BROWSE TEXT NUMBER EMAIL
values: List<ListUserInputValueInfo> // optional, may be null. Only used for LIST type
ListUserInputValueInfo
value: string
label: string
AuditLogInfo
category: string
type: string,
eventContext: {
serverId: string
traceId: string
source: string
requestDateTime: string, // in ISO-8601 format
request: {
AuthenticatedRequest: {
executingUser: {
user: { // optional, may be null
name: string,
id: int,
accountId: int,
providerId: int
}
}
}
},
sourceSocket: { // optional, may be null
address: string,
port: int
},
destinationSocket: { // optional, may be null
address: string,
port: int
},
requestingDomain: string, // optional, may be null
auditLogCustomOpName: string, // optional, may be null
accountAccessReason: { // optional, may be null
issue: string,
reason: string
},
accountId: int
},
timestamp: string // in ISO-8601 format
id: int // optional, may be null
intent: object, // optional, may be null
intentResult: object, // optional, may be null
result: object, // optional, may be null
customOp: object, // optional, may be null
updatedType: string // optional, may be null
objectType: string, // optional, may be null
entityType: string, // optional, may be null
oldEntity: object, // optional, may be null
toAddEntity: object, // optional, may be null
previousEntity: object, // optional, may be null
toDeleteEntity: object, // optional, may be null
updatedChildren: object, // optional, may be null
access: object, // optional, may be null
addedAccess: object, // optional, may be null
removedAccess: object, // optional, may be null
parent: object // optional, may be null
error: object // optional, may be null
EndpointInfo
"endpointId": string,
"description": string,
"endpointType": string, //Server, Printer, PC Client, Browser extension, Mobile device
"authorized": boolean
BalanceConfigInfo
accountId: int // the account this configuration belongs to
enabled: boolean // per-account balance/quota enable switch
bwNormalPage: decimal
bwLargePage: decimal
colorNormalPage: decimal
colorLargePage: decimal
BalanceConfigData
enabled: boolean // required
bwNormalPage: decimal // required, zero or greater
bwLargePage: decimal // required, zero or greater
colorNormalPage: decimal // required, zero or greater
colorLargePage: decimal // required, zero or greater
BalanceCheckData
uuid: string // UUID of the document to check
userName: string
providerId: int
totalPages: int
colorPages: int
paperSize: string
copies: int
BalanceCheckInfo
balanceEnabled: boolean // whether balance/quota is enabled for the account
sufficientBalance: boolean // whether the current balance covers the calculated cost
currentBalance: decimal
calculatedCost: decimal // cost computed for the document from the price list
UserBalanceInfo
userName: string
providerId: int
quotaBalance: decimal
walletBalance: decimal
totalBalance: decimal
lastUpdated: Option<string> // in ISO-8601 format
BalanceTransactionInfo
id: int
userId: int // the user the transaction belongs to
userName: string
providerId: int
accountId: int
quotaAmount: decimal // negative for deductions/withdrawals
walletAmount: decimal
transactionType: string // TOP_UP, DEDUCTION, ADJUSTMENT, RESERVATION, RESERVATION_RELEASE, INITIAL, WITHDRAW
quotaBalanceAfter: Option<decimal>
walletBalanceAfter: Option<decimal>
documentUuid: Option<string>
description: string
adminUserId: Option<int>
timestamp: Option<string> // in ISO-8601 format
BalanceTransactionData
userName: string
providerId: int
operation: string // "add", "remove" or "set"
balanceType: string // "quota" or "wallet"; "set" supports only "quota"
amount: decimal // add/remove: positive amount; set: target value (zero or greater)
description: string // optional, default ""
PagedResult<T>
items: list<T>
recordsOnPage: int
nextPageToken: Option<string> // absent on the last page
BalancePolicyInfo
id: int // 0 for the virtual (not yet persisted) default policy
accountId: int // the account this policy belongs to
policyName: string
balanceType: string // free, quota, wallet, quota_wallet
priority: int // 0 = default policy; lower number = higher precedence
isDefault: boolean
initialBalance: decimal
groupIds: list<int> // always empty for the default policy
schedule: Option<BalancePolicyScheduleInfo> // present when the policy has a reset schedule
lastUpdated: Option<string> // in ISO-8601 format
BalancePolicyScheduleInfo
enabled: boolean // whether the schedule is active
frequency: string // weekly, monthly, quarterly, yearly
scheduledTime: string // first run, ISO-8601 offset date-time normalized to UTC
targetAmount: decimal // amount the policy's users are reset to on each run
BalancePolicyData
policyName: string // required, max 256 characters
balanceType: string // required: free, quota, wallet, quota_wallet
initialBalance: decimal // optional, default 0, must be zero or greater
groupIds: list<int> // optional, default empty; must belong to the account
schedule: BalancePolicyScheduleData // optional; absent = leave the reset schedule unchanged
BalancePolicyScheduleData
enabled: boolean // optional, default true; false removes the schedule
frequency: string // weekly, monthly, quarterly, yearly; required when enabled
scheduledTime: string // first run, ISO-8601 offset date-time; required when enabled
targetAmount: decimal // optional, default 0, must be zero or greater
BalancePolicyOrderData
orderedPolicyIds: list<int> // exactly all non-default policy ids in the desired order