Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AclManagementResourceImpl
  • /management/acls
  • /management/acls/{aclId}
  • /management/deleted/acls
  • /management/acls/named/{aclName}
  • /management/acls/{aclId}/acls
  • /management/deleted/acls/{aclId}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • PUT
This resource provides endpoints for ACL management.
ArchiveResourceImpl
  • /archives
  • /archive/{archiveId}
  • /archives/{archive-name}
  • /archive/documents/{archiveId}
  • /archive/folders/{archiveId}
  • /archive/lookup-entries/{archiveId}
  • /archive/{archiveId}/fields
  • /archive/documents/{archiveId}/fields
  • /archive/folders/{archiveId}/fields
  • /archive/lookup-entries/{archiveId}/fields
  • /archive/{archiveId}/fields/{fieldId}
  • /archive/documents/{archiveId}/fields/{fieldId}
  • /archive/folders/{archiveId}/fields/{fieldId}
  • /archive/lookup-entries/{archiveId}/fields/{fieldId}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provides endpoints that provide information about archives (DDCs).
ChangePasswordResourceImpl
  • /management/current-user/password
  • PUT
This resource provides an endpoint that can be used to change a user's password.
DocumentResourceImpl
  • /documents
  • /documents/{documentId}
  • /documents/revisions/{revisionId}
  • /documents/{documentId}/acls
  • /documents/{documentId}/lock
  • /archive/documents/{archiveId}/content
  • /documents/revisions/{revisionId}/all
  • /documents/revisions/{revisionId}/index
  • /documents/revisions/{revisionId}/element/{elementId}
  • /documents/revisions/{revisionId}/fulltext/{fieldName}
  • /documents/revisions/{revisionId}/index/{fieldName}
  • /documents/revisions/{revisionId}/element/{elementId}/children
  • /documents/revisions/{revisionId}/element/{elementId}/renditions/{type}
  • POST
  • GET
  • DELETE GET PUT
  • GET
  • DELETE POST
  • GET
  • DELETE
  • GET
  • DELETE GET PUT
  • POST
  • GET
  • POST
  • GET
This resource provides endpoints for read and write operations on documents.
FolderResourceImpl
  • /folders
  • /folders/{folderId}
  • /folders/{folderId}/acls
  • /folders/{folderId}/documents
  • /folders/{folderId}/folders
  • /folders/{folderId}/index
  • /folders/{folderId}/parent
  • /folders/{folderId}/properties
  • /archive/folders/{archiveId}/content
  • /folders/{folderId}/documents/{documentId}
  • /folders/{folderId}/index/{fieldName}
  • POST
  • DELETE GET PUT
  • GET
  • GET PUT
  • GET
  • GET PUT
  • PUT
  • PUT
  • GET
  • DELETE
  • GET
This resource provides endpoints for folder handling.
GroupManagementResourceImpl
  • /management/groups
  • /management/deleted/groups
  • /management/groups/{groupId}
  • /management/deleted/groups/{groupId}
  • /management/groups/named/{groupName}
  • /management/groups/{groupId}/acls
  • /management/groups/{groupId}/extension
  • /management/groups/{groupId}/nestedgroups
  • /management/groups/{groupId}/nestedusers
  • /management/groups/{groupId}/nestedgroups/{memberId}
  • /management/groups/{groupId}/nestedusers/{memberId}
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
  • DELETE GET PUT
  • GET POST
  • GET POST
  • DELETE
  • DELETE
This resource provides endpoints for group management.
LicenseResourceImpl
  • /license
  • DELETE
This respource provides license related functionality.
LookupEntryResourceImpl
  • /lookup-entry
  • /lookup-entry/{id}
  • /lookup-entry/{id}/acls
  • /archive/lookup-entries/{archiveId}/content
  • /lookup-entry/{id}/index/{fieldName}
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
This resource provides endpoints for read and write operations on lookup entries.
RecordResourceImpl
  • /records
  • POST
This resource provides endpoints for record handling.
RoleManagementResourceImpl
  • /management/roles
  • /management/deleted/roles
  • /management/roles/{roleId}
  • /management/deleted/roles/{roleId}
  • /management/roles/named/{roleName}
  • /management/roles/{roleId}/acls
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
This resource provides endpoints for role management.
TenantManagementResourceImpl
  • /management/tenants
  • /management/deleted/tenants
  • /management/tenants/{tenantId}
  • /management/deleted/tenants/{tenantId}
  • /management/tenants/named/{tenantName}
  • /management/tenants/{tenantId}/extension
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • DELETE GET PUT
This resource provides endpoints for tenant management.
UserManagementResourceImpl
  • /management/users
  • /management/deleted/users
  • /management/users/current
  • /management/users/current-context
  • /management/users/{userId}
  • /management/deleted/users/{userId}
  • /management/users/named/{userName}
  • /management/users/{userId}/acls
  • /management/users/{userId}/extension
  • /management/users/{userId}/groups
  • /management/users/{userId}/password
  • /management/users/{userId}/password/expiration
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • PUT
  • GET PUT
This resource provides endpoints for user management.
WorkflowDefinitionResourceImpl
  • /workflow/definitions
  • /workflow/definitions/{definitionId}
  • /workflow/definitions/{definitionId}/transition
  • GET
  • GET POST
  • GET
This resource provides endpoints that provide functionality for workflow definitions.
WorkflowInboxResourceImpl
  • /workflow/inboxes
  • /workflow/inboxes/groups
  • /workflow/inboxes/organization
  • /workflow/inboxes/personal
  • /workflow/inboxes/substitutes
  • /workflow/inboxes/{inboxId}
  • /workflow/inboxes/personal/items
  • /workflow/inboxes/{inboxId}/items
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provides endpoints that provide access to a workflow inbox.
WorkflowProcessResourceImpl
  • /workflow/processes
  • /workflow/processes/{processId}
  • GET
  • DELETE GET
This resource provides endpoints for the handling of workflow processes.
WorkflowTaskResourceImpl
  • /workflow/tasks/{taskId}
  • /workflow/tasks/{taskId}/comments
  • /workflow/tasks/{taskId}/forward
  • /workflow/tasks/{taskId}/index
  • /workflow/tasks/{taskId}/transitions
  • /workflow/tasks/{taskId}/ownership/acquire
  • /workflow/tasks/{taskId}/ownership/revoke
  • GET
  • GET POST
  • POST
  • GET POST
  • GET
  • PUT
  • PUT
This resource provides endpoints for the handling of workflow tasks.

Data Types

JSON

type description
AccessRight
AclListItemType
AclPropertiesType
AclReferenceType
AclType
ActorListItemType
ActorListItemTypeOfUserReferenceType
ActorReferenceType
ActorType
ActorTypeEnum
AnnotationAccessDataType
AnnotationType
ApplicationError
ArchiveContentEnum
ArchiveFeatureEnum
ArchiveIsolationEnum
ArchiveListItemType
ArchiveListItemTypeAdapter
ArchiveReferenceType
ArchiveType
ArchiveTypeAdapter
ArrowAnnotationType
BackendSystemError Backend error definition.
BinaryFieldType
BooleanFieldType
ClientError
ConcurrentWriteDetails These are the details of a ConcurrentWriteException.
ContentDocumentElementType
ContentMetaDataType
ContentMetaDataTypeAdapter
CounterFieldType
CreateFolderInputType
CreateLookupEntryInputType
CreateRecordInputType
CreateUserPropertiesType
CurrencyFieldType
DateFieldType
DateTimeFieldType
DocumentContentMetaDataType
DocumentContentMetaDataTypeAdapter
DocumentElementReferenceType
DocumentElementStoreInformationType
DocumentElementType
DocumentLockedDetails These are the details of a ObjectLockedException concerning documents.
DocumentNodeType
DocumentReferenceType
DocumentRevisionListItemType
DocumentRevisionListItemTypeAdapter
DocumentRevisionReferenceType
DocumentRevisionType
DocumentStoreInformationType
EnumFieldType
EnumListFieldType
ErrorCodeType
ErrorConstantType
ErrorDetailsType
ErrorType
ExtensionPropertiesType
FieldDefinition
FieldDefinitionAdapter
FieldType
FieldTypeEnum
File
FileDocumentElementType
FloatFieldType
FolderListItemType
FolderListItemTypeAdapter
FolderReferenceType
GenericWorkflowErrorDetails This error details describe generic workflow errors.
GroupAccessType
GroupListItemType
GroupPropertiesType
GroupReferenceType
GroupType
HashDescriptor
IllegalInputError
InboxListItemType A InboxListItemType holds the most important information about a workflow-inbox.
InboxReferenceType This ReferenceType identifies workflow-inboxes.
InboxTypeEnumeration This enumeration contains the possible types of workflow-inboxes.
  • PERSONAL: A user's personal inbox
  • GROUP: A inbox belonging to a group
  • ORGANIZATION: A inbox belonging to an organization-unit
  • SUBSTITUTE: A inbox belonging to a user that is substituted by the current user
InputStream
InputStreamReferenceType
IntegerFieldType
InternalCreateFolderInputType
LicenseEnumeration
LinkDocumentElementType
ListFieldType
ListItemType
LookupEntryListItemType
LookupEntryListItemTypeAdapter
LookupEntryLockedDetails These are the details of a ObjectLockedException concerning lookup-entries.
LookupEntryReferenceType
LookupFieldType
LookupListFieldType
MandatoryConstraintViolationDetails These are the details for MandatoryConstraintViolationException.
MarkerAnnotationType
ModificationMetaDataType
ObjectLockedDetails These are the details of ObjectLockedException.
PageDefinition
PasswordExpiration
PasswordExpiredDetails These are the details of com.lexmark.saperion.exceptions.system.PasswordExpiredException.
PictureAnnotationType
PropertyType
RecipientSelectionType A recipient selection holds the information if and how the user for a workflow step has to be selected by in the previous workflow step.
ReferenceType
ResourceType
RetentionDescription
RolePropertiesType
RoleReferenceType
RoleType
ScannedDocumentElementType
SearchError
SearchResultPageOfAclListItemType
SearchResultPageOfArchiveListItemType
SearchResultPageOfDocumentRevisionListItemType
SearchResultPageOfGroupType
SearchResultPageOfInboxListItemType
SearchResultPageOfObject
SearchResultPageOfRoleType
SearchResultPageOfTenantType
SearchResultPageOfUserType
SearchResultPageOfWorkflowDefinitionListItemType
SearchResultPageOfWorkflowProcessListItemType
SecurityAnnotationType
SecurityError Error code implementation for security exceptions.
StringFieldType
StructureCompositeDocumentElementType
SystemError
SystemFieldWriteDetails These are the details for SystemFieldWriteException.
TaskCapabilitiesEnum The task capabilities enumeration defines the functions that can be called on a workflow task.
TaskCommentReferenceType This ReferenceType identifies comments at workflow tasks.
TaskCommentType The task comment type represents a comment of a workflow process. When a workflow was started users add comments in order to provide additional information for a later stage, for example when performing a task.

Comments are hierarchically structured. Each comment can have zero or more sub-comments. It is possible to add new comments to existing comments.

TaskForwardInputType The forward task input type is the protocol binding type for the task forward operation. The transition through which the task is forwarded is identified by the specified transition id. Additionally it is possible to specify a comment and recipients. If no transition id is specified the server uses the default transition to forward the task, if possible.
TaskPropertyType The task properties define all property values that can be directly changed by an application.
TaskReferenceType This ReferenceType identifies workflow tasks.
TaskType The task type is a representation of a task in a running workflow process. The task object has a number of properties such as the task owner, user data, or escalation information.

Moreover, tasks can specify a number of transition definitions. These transition definitions specify the different paths that a task can be forwarded in an workflow.

TechnicalUserContextType
TenantPropertiesType
TenantReferenceType
TenantType
TextAnnotationType
TimeFieldType
TimeInfoType Specifies task related time information.
TransitionDefinitionType A transition definition represents the different exit path of a workflow node. Workflow nodes represent single steps in a workflow. Transitions (or task transitions) define all possible paths of a workflow node. After a workflow step was executed a valid transition to the next workflow step must be chosen. This is done either automatically or by the work step itself.
UniqueConstraintViolationDetails These are the details for MandatoryConstraintViolationException.
UpdateFolderInputType
UpdateLookupEntryInputType
UserAccessType
UserContextType
UserListItemType
UserPropertiesType
UserReferenceType
UserType
WorkflowActorRequiredDetails Details for the WorkflowActorRequiredException.
WorkflowDefinitionListItemType This list item type holds easy to access data of a workflow definition stored in the system. It works a short info for workflow definition types in lists.
WorkflowDefinitionReferenceType This ReferenceType identifies workflow definitions.
WorkflowDefinitionType The workflow definition type represents a workflow definition stored in the system. An application can start a new workflow process for a document based on an existing workflow definition.
WorkflowError Error code implementation for application exceptions.
WorkflowProcessListItemType This list item type holds easy to access data of a workflow process instance. It works a short info for workflow process instances in lists.
WorkflowProcessReferenceType This ReferenceType identifies instances of workflow processes.
WorkflowProcessStateEnum The process state enumeration lists all possible states of a workflow process.
WorkflowProcessType A workflow process is a workflow that was started for a particular document. Each workflow is started based on a workflow definition.
WorkflowProcessTypeEnum Defines the possible workflow types.
WorkflowStartInputType This class combines the entities necessary to start a workflow.
WrongArchiveKindDetails This class holds the exception details of WrongArchiveKindException.
XmlFieldType

XML

Default Namespace (schema)
type description
licenseEnumeration
listItemType
modificationMetaDataType
propertyType
referenceType
resourceType
accessRight
aclListItemType
aclPropertiesType
aclReferenceType
aclType
actorListItemType
actorReferenceType
actorType
actorTypeEnum
createUserPropertiesType
extensionPropertiesType
groupAccessType
groupListItemType
groupPropertiesType
groupReferenceType
groupType
passwordExpiration
rolePropertiesType
roleReferenceType
roleType
technicalUserContextType
tenantPropertiesType
tenantReferenceType
tenantType
userAccessType
userContextType
userListItemType
userPropertiesType
userReferenceType
userType
archiveContentEnum
archiveFeatureEnum
archiveIsolationEnum
archiveListItemType
archiveListItemTypeAdapter
archiveReferenceType
archiveType
archiveTypeAdapter
binaryFieldType
booleanFieldType
counterFieldType
currencyFieldType
dateFieldType
dateTimeFieldType
enumFieldType
enumListFieldType
fieldDefinition
fieldDefinitionAdapter
fieldType
fieldTypeEnum
floatFieldType
integerFieldType
listFieldType
lookupFieldType
lookupListFieldType
stringFieldType
timeFieldType
xmlFieldType
annotationAccessDataType
annotationType
arrowAnnotationType
contentDocumentElementType
contentMetaDataType
contentMetaDataTypeAdapter
documentContentMetaDataType
documentContentMetaDataTypeAdapter
documentElementReferenceType
documentElementStoreInformationType
documentElementType
documentReferenceType
documentRevisionListItemType
documentRevisionListItemTypeAdapter
documentRevisionReferenceType
documentRevisionType
documentStoreInformationType
fileDocumentElementType
hashDescriptor
inputStreamReferenceType
linkDocumentElementType
markerAnnotationType
pictureAnnotationType
retentionDescription
scannedDocumentElementType
securityAnnotationType
structureCompositeDocumentElementType
textAnnotationType
errorCodeType
errorConstantType
errorDetailsType
errorType
applicationError
genericWorkflowErrorDetails This error details describe generic workflow errors.
searchError
workflowActorRequiredDetails Details for the WorkflowActorRequiredException.
workflowError Error code implementation for application exceptions.
clientError
concurrentWriteDetails These are the details of a ConcurrentWriteException.
documentLockedDetails These are the details of a ObjectLockedException concerning documents.
illegalInputError
lookupEntryLockedDetails These are the details of a ObjectLockedException concerning lookup-entries.
mandatoryConstraintViolationDetails These are the details for MandatoryConstraintViolationException.
objectLockedDetails These are the details of ObjectLockedException.
systemFieldWriteDetails These are the details for SystemFieldWriteException.
uniqueConstraintViolationDetails These are the details for MandatoryConstraintViolationException.
wrongArchiveKindDetails This class holds the exception details of WrongArchiveKindException.
backendSystemError Backend error definition.
passwordExpiredDetails These are the details of com.lexmark.saperion.exceptions.system.PasswordExpiredException.
securityError Error code implementation for security exceptions.
systemError
createFolderInputType
createRecordInputType
folderListItemType
folderListItemTypeAdapter
folderReferenceType
internalCreateFolderInputType
updateFolderInputType
createLookupEntryInputType
lookupEntryListItemType
lookupEntryListItemTypeAdapter
lookupEntryReferenceType
updateLookupEntryInputType
pageDefinition
searchResultPage
inboxListItemType A InboxListItemType holds the most important information about a workflow-inbox.
inboxReferenceType This ReferenceType identifies workflow-inboxes.
inboxTypeEnumeration This enumeration contains the possible types of workflow-inboxes.
  • PERSONAL: A user's personal inbox
  • GROUP: A inbox belonging to a group
  • ORGANIZATION: A inbox belonging to an organization-unit
  • SUBSTITUTE: A inbox belonging to a user that is substituted by the current user
recipientSelectionType A recipient selection holds the information if and how the user for a workflow step has to be selected by in the previous workflow step.
taskCapabilitiesEnum The task capabilities enumeration defines the functions that can be called on a workflow task.
taskCommentReferenceType This ReferenceType identifies comments at workflow tasks.
taskCommentType The task comment type represents a comment of a workflow process. When a workflow was started users add comments in order to provide additional information for a later stage, for example when performing a task.

Comments are hierarchically structured. Each comment can have zero or more sub-comments. It is possible to add new comments to existing comments.

taskForwardInputType The forward task input type is the protocol binding type for the task forward operation. The transition through which the task is forwarded is identified by the specified transition id. Additionally it is possible to specify a comment and recipients. If no transition id is specified the server uses the default transition to forward the task, if possible.
taskPropertyType The task properties define all property values that can be directly changed by an application.
taskReferenceType This ReferenceType identifies workflow tasks.
taskType The task type is a representation of a task in a running workflow process. The task object has a number of properties such as the task owner, user data, or escalation information.

Moreover, tasks can specify a number of transition definitions. These transition definitions specify the different paths that a task can be forwarded in an workflow.

timeInfoType Specifies task related time information.
transitionDefinitionType A transition definition represents the different exit path of a workflow node. Workflow nodes represent single steps in a workflow. Transitions (or task transitions) define all possible paths of a workflow node. After a workflow step was executed a valid transition to the next workflow step must be chosen. This is done either automatically or by the work step itself.
workflowDefinitionListItemType This list item type holds easy to access data of a workflow definition stored in the system. It works a short info for workflow definition types in lists.
workflowDefinitionReferenceType This ReferenceType identifies workflow definitions.
workflowDefinitionType The workflow definition type represents a workflow definition stored in the system. An application can start a new workflow process for a document based on an existing workflow definition.
workflowProcessListItemType This list item type holds easy to access data of a workflow process instance. It works a short info for workflow process instances in lists.
workflowProcessReferenceType This ReferenceType identifies instances of workflow processes.
workflowProcessStateEnum The process state enumeration lists all possible states of a workflow process.
workflowProcessType A workflow process is a workflow that was started for a particular document. Each workflow is started based on a workflow definition.
workflowProcessTypeEnum Defines the possible workflow types.
workflowStartInputType This class combines the entities necessary to start a workflow.
file
inputStream
instant