ProcessWorkstepController
The following operations are supported. For a formal definition, please review the Service Description.
-
AcceptWorkstepAgreement_v1
Method to accept the pending agreement task
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
AddAttachmentToWorkstepDocument_v2
Method attaches a document to the first document of the workstep and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[byte[]] 'attachmentContent': The document content.
[string] 'attachmentName': The name of the attachment.
[string] 'attachmentId': If the attachment is assigned to a task, the taskId, otherwise null.
[xml string] 'transactionInformation': Information about the transaction. -
AddAttachmentToWorkstepDocument_v3
Method attaches a document to a workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[byte[]] 'attachmentContent': The document content.
[string] 'attachmentName': The name of the attachment.
[string] 'attachmentId': If the attachment is assigned to a task, the taskId, otherwise null.
[string] 'docRefNumber': Defines, to which document of the workstep the file is attached
[xml string] 'transactionInformation': Information about the transaction. -
AddAttachmentToWorkstepDocument_v4
Method attaches a document to a workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[byte[]] 'attachmentContent': The document content.
[string] 'addAttachmentConfiguration': the configuration for adding the attachment.
[xml string] 'transactionInformation': Information about the transaction. -
AddFreeHandAnnotations_v2
Method adds adhoc freehand annotations to the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'annotationConfig': The configuration for the freehand annotation.
[xml string] 'transactionInformation': Information about the transaction. -
AddPictureAnnotation_v1
Method adds a picture annotation to the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'annotationConfig': The configuration for the picture annotation.
[byte[]] 'annotationContent': The picture content.
[xml string] 'transactionInformation': Information about the transaction. -
AddPredefinedTypewriterAnnotations_v1
Method adds predefined typewriter annotations to the workstep document and returns new workstep information
[string] 'workstepId': The id of the workstep.
[xml string] 'predefinedTypewriterAnnotationInformation': Additional configuration for the AddPredefinedTypewriterAnnotations call. predefinedTypewriterAnnotationInformation.TaskId is mandatory! other properties are optional
[xml string] 'transactionInformation': Information about the transaction. -
AddTypewriterAnnotations_v2
Method adds adhoc typewriter annotations to the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'annotationConfig': The configuration for the tyewriter annotation.
[xml string] 'transactionInformation': Information about the transaction. -
AppendDocumentToWorkstepDocument_v2
Method appends a document at the end of the first workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[byte[]] 'attachmentContent': The document content.
[string] 'attachmentName': The name of the attachment.
[string] 'attachmentId': If the attachment is assigned to a task, the taskId, otherwise null.
[xml string] 'transactionInformation': Information about the transaction. -
AppendDocumentToWorkstepDocument_v3
Method appends a document at the end of a workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[byte[]] 'attachmentContent': The document content.
[string] 'attachmentName': The name of the attachment.
[string] 'attachmentId': If the attachment is assigned to a task, the taskId, otherwise null.
[string] 'docRefNumber': Defines, to which document of the workstep the file is appended.
[xml string] 'transactionInformation': Information about the transaction. -
AppendEventToAuditTrail_v1
Method appends an external event to the AuditTrail of the given workstep
[string] 'workstepId': The id of the workstep.
[xml string] 'auditTrailEvent': The event which should be entered into the worksteps AuditTrail.
[xml string] 'transactionInformation': Information about the transaction. -
AppendFileToWorkstep_v1
Append a pdf document to an existing workstep.
[string] 'workstepId': The id of the workstep.
[string] 'documentId': The id of the document to append to the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
AppendTasksToWorkstep_v1
Append tasks to an existing workstep.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for the tasks to be appended.
[xml string] 'transactionInformation': Information about the transaction. -
AuthenticateForWorkstep_v1
Method authenticates the user using the given information
[string] 'workstepId': The id of the workstep.
[string] 'provider': The unique Provider-Identifier which should be used
[string] 'code': The information token from the Login Provider or the PIN
[xml string] 'transactionInformation': Information about the transaction. -
CancelTransactionCode_v1
Cancel a transaction code (e.g. for BankId).
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for the transaction code.
[xml string] 'transactionInformation': Information about the transaction. -
ColorizeWorkstepFormFields_v1
Colorizes one or more pdf form fields.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for form field colorization.
[xml string] 'transactionInformation': Information about the transaction. -
ConfirmReading_v2
Method confirms a reading task of the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[string] 'confirmReadingId': The id of the reading task to confirm.
[xml string] 'transactionInformation': Information about the transaction. -
ConfirmTransactionCode_v1
Method to confirm data received by SendTransactionCode_v2 to go further within a process (e.g. enroll a requested disposable certificate)
[string] 'workstepId': The id of the workstep.
[xml string] 'confirmTransactionCodeConfiguration': Additional configuration for the authentication
[xml string] 'transactionInformation': Information about the transaction. -
CreateAdhocWorkstep_v2
[Deprecated: Please check release notes]
Method creates an adhoc workstep for the given document and returns the workstep information.
[string] 'documentId': The id of the workstep document.
[xml string] 'createAdhocWorkstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
CreateAdhocWorkstep_v3
Method creates an adhoc workstep for the given list of documents and returns the workstep information.
[string[]] 'documentIds': The ids of the workstep documents.
[xml string] 'createAdhocWorkstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
CreateAdhocWorkstep_v4
Method creates an adhoc workstep for the given list of documents and returns the workstep information.
[string] 'customizationId': The customization identifier (can be null).
[string[]] 'documentIds': The ids of the workstep documents.
[xml string] 'createAdhocWorkstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
CreateWorkstepAdobe_v1
Method creates a workstep with the given configuration and returns the workstep information. If form fields are given, the values given are set in the document.
[string] 'documentId': The id of the workstep document.
[xml string] 'workstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
CreateWorkstepAdobe_v2
Method creates a workstep with the given configuration and returns the workstep information. If form fields are given, the values given are set in the document.
[string[]] 'documentIds': The ids of the documents used by the workstep.
[xml string] 'workstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
CreateWorkstepAdobe_v3
Method creates a workstep with the given configuration and returns the workstep information. If form fields are given, the values given are set in the document.
[string] 'customizationId': The customization identifier (can be null).
[string[]] 'documentIds': The ids of the documents used by the workstep.
[xml string] 'workstepConfiguration': The configuration for the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
DeclineWorkstepAgreement_v1
Method to reject the pending agreement or authentication task
[string] 'workstepId': The id of the workstep.
[string] 'reason': The reason for declining the agreement.
[xml string] 'transactionInformation': Information about the transaction. -
ExtendPayload_v1
Method to extend a payload (data which will be used e.g. signatureImage) for batch signing
[string] 'workstepId': The id of the workstep.
[xml string] 'extendPayloadConfiguration': Contains the data with which the payload will be extended
[xml string] 'transactionInformation': Information about the transaction. -
FillFormsGroup_v2
Method fills the form group of the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'formsConfig': The configuration for the forms group to fill.
[xml string] 'transactionInformation': Information about the transaction. -
FinalizeSignWorkstepDocument_v2
Method to finalize an external signature. Returns the information needed to sign the document.
[string] 'workstepId': The id of the workstep.
[xml string] 'signatureConfig': The configuration for the signature.
[xml string] 'transactionInformation': Information about the transaction. -
FinishExternalSigningProcess_v1
Method to finish an external signing process
[string] 'workstepId': The id of the workstep.
[xml string] 'signingConfiguration': Configuration values for the signature
[xml string] 'transactionInformation': Information about the transaction. -
FinishWorkstep_v2
Method finishes the workstep and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
FinishWorkstep_v3
Method finishes the workstep and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'finishConfiguration': The configuration for finishing.
[xml string] 'transactionInformation': Information about the transaction. -
GetAiAssistantResponse_v1
Method returns an AI assistant answer chunked depending on the PDF text and asked question.
[string] 'workstepId': The id of the workstep.
[string] 'configuration': The configuration for getting answer result.
[xml string] 'transactionInformation': Information about the transaction. -
GetAiDocumentSummary_v1
Method returns textual summary of a document powered by AI.
[string] 'workstepId': The id of the workstep.
[string] 'configuration': The configuration for getting summary result.
[xml string] 'transactionInformation': Information about the transaction. -
GetAuditTrailWithId_v1
Method returns the FileContainer for the AuditTrail of the given workstep
[string] 'workstepId': The id of the workstep.
[xml string] 'getAuditTrailConfiguration': The configuration how the auditTrail should be returned
[xml string] 'transactionInformation': Information about the transaction. -
GetBankIdQrCode_v1
Method returns information for generating an animated QR code for BankID.
[string] 'workstepId': The id of the workstep.
[string] 'transactionId': The current transactionId.
[string] 'time': The time in seconds since starting the request.
[xml string] 'transactionInformation': Information about the transaction. -
GetClientLicenseInformationForDeviceDriver_v1
Method returns information about the client license.
[xml string] 'transactionInformation': Information about the transaction.
[string] 'connectionId': ConnectionId with Device Driver. -
GetClientLicenseInformationForDeviceDriver_v2
Method returns information about the client license.
[string] 'customizationId': The customization identifier (can be null).
[xml string] 'transactionInformation': Information about the transaction.
[string] 'connectionId': ConnectionId with Device Driver. -
GetClientLicenseInformation_v1
Method returns information about the client license.
[xml string] 'transactionInformation': Information about the transaction. -
GetClientLicenseInformation_v2
Method returns information about the client license.
[string] 'customizationId': The customization identifier (can be null).
[xml string] 'transactionInformation': Information about the transaction. -
GetDisclaimerText_v1
This method retrieves the disclaimer text for specific request. If form fields are given, the values given are set in the document.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The GetDisclaimerTextConfiguration of the request.
[string] 'languageCodeShort': This identifies the target language (2-letter language codes: en, it,...).
[string] 'languageCodeShortFallback': This identifies the fallback language which should be used, if the disclaimer is not available in the target language is not (3-letter language codes: en, it,...).
[string] 'languageCodeLong': This identifies the target language (3-letter language codes: ENG, ITA,...).
[string] 'languageCodeLongFallback': This identifies the fallback language which should be used, if the disclaimer is not available in the target language is not (3-letter language codes: ENG, ITA,...).
[xml string] 'transactionInformation': Information about the transaction. -
GetDocumentContentInformation_v2
[Deprecated: Please check release notes]
Method returns information about the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
GetDocumentContentInformation_v3
Method returns information about the workstep document.
[string] 'workstepId': The id of the workstep.
[int] 'docRefNumber': The document reference number of the workstep document you want the information from.
[xml string] 'transactionInformation': Information about the transaction. -
GetDocumentContent_v2
[Deprecated: Please check release notes]
Method returns the content of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
GetDocumentContent_v3
Method returns the content of a single workstep document.
[string] 'workstepId': The id of the workstep.
[int] 'docRefNumber': The document reference number of the document you want the content of.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileInformation_v2
[Deprecated: Please check release notes]
Method returns information about the document with the given id.
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileInformation_v3
Method returns information about the document with the given id.
[string] 'workstepId': The id of the workstep.
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileInformation_v4
Method returns information about the document with the given id.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithIdChunk_v2
[Deprecated: Please check release notes]
Method returns the chunk of a document.
[string] 'fileId': The id of the document.
[long] 'startIdx': The start index of the document chunk.
[long] 'length': The length of the document chunk.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithIdChunk_v3
Method returns the chunk of a document.
[string] 'workstepId': The id of the workstep.
[string] 'fileId': The id of the document.
[long] 'startIdx': The start index of the document chunk.
[long] 'length': The length of the document chunk.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithIdChunk_v4
Method returns the chunk of a document.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[long] 'startIdx': The start index of the document chunk.
[long] 'length': The length of the document chunk.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithId_v2
[Deprecated: Please check release notes]
Method returns the content of the document with the given id.
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithId_v3
Method returns the content of the document with the given id.
[string] 'workstepId': The id of the workstep.
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFileWithId_v4
Method returns the content of the document with the given id.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
GetFlattenedDocumentContent_v2
[Deprecated: Please check release notes]
Method returns the flattened content of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
GetFlattenedDocumentContent_v3
Method returns the flattened content of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for flattening.
[xml string] 'transactionInformation': Information about the transaction. -
GetFlattenedDocumentInformation_v2
[Deprecated: Please check release notes]
Method returns information about the flattened content of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
GetFlattenedDocumentInformation_v3
Method returns information about the flattened content of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for flattening.
[xml string] 'transactionInformation': Information about the transaction. -
GetFlattenedWorkstepDocuments_v1
Method creates a list of documents with the flattened content of the recent workstep documents.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for flattening.
[xml string] 'transactionInformation': Information about the transaction. -
GetGenericSigningPluginAuthenticationStatus_v1
Method returns status of an authentication for a Generic Signing Plugin signature.
[string] 'workstepId': The id of the workstep.
[string] 'configuration': The configuration for the Generic Signing Plugin result.
[xml string] 'transactionInformation': Information about the transaction. -
GetLicenseDetailsForUser_v1
Method gets license details for the given user.
[string] 'email': The email address for the user.
[xml string] 'transactionInformation': Information about the transaction. -
GetLicenseDetailsForUser_v2
Method gets license details for the given user.
[string] 'customizationId': The customization identifier (can be null).
[string] 'email': The email address for the user.
[xml string] 'transactionInformation': Information about the transaction. -
GetOriginalWorkstepConfiguration_v1
Method returns the configuration the workstep was created with.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
GetPushResult_v1
Method returns if push authentication for a signature was already performed.
[string] 'workstepId': The id of the workstep.
[string] 'configuration': The GetPushResultConfiguration of the request.
[xml string] 'transactionInformation': Information about the transaction. -
GetServerInformation_v1
Method returns information about the services (Installed products including versions -
GetServerInformation_v2
Method returns information about the services (Installed products including versions.
'customizationId': The customization identifier (can be null). -
GetSignatureImage_v1
Method to get the appearance of signature image in base64 format.
[string] 'workstepId': The id of the workstep.
[string] 'signatureId': The ID of the signature field for which the image should be created
[string] 'signatureType': The type of the signature for which the image should be created
[xml string] 'signatureClientRenderConfig': Contains additional data for the signature
[xml string] 'transactionInformation': Information about the transaction. -
GetWorkstepDocumentImageSection_v2
Method generates an image of a configured page section and returns information about this image.
[string] 'workstepId': The id of the workstep.
[xml string] 'pdf2ImageConfig': The configuration how the image section should be generated.
[xml string] 'transactionInformation': Information about the transaction. -
GetWorkstepDocumentImages_v2
Method generates images for the pages of the document and returns information about this images.
[string] 'workstepId': The id of the workstep.
[xml string] 'pdf2ImageConfig': The configuration how the images should be generated.
[xml string] 'transactionInformation': Information about the transaction. -
GetWorkstepInformation_v2
Method returns the information about a workstep.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
IsPasswordRequired_v2
Method returns whether a password is required for the document with the given id.
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
IsPasswordRequired_v3
[Deprecated: Please check release notes]
Method returns whether a password is required for the document with the given id.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[xml string] 'transactionInformation': Information about the transaction. -
PrepareGenericSigningPluginSignature_v1
Prepares a signature for signing via an Generic Signing Plugin.
[string] 'workstepId': The id of the workstep.
[xml string] 'signingConfiguration': Configuration values for the signature
[xml string] 'signatureClientRenderConfig': Contains additional data for the signature
[xml string] 'transactionInformation': Information about the transaction. -
PreparePayload_v1
Method to prepare a payload (data which will be used e.g. signatureImage) for batch signing
[string] 'workstepId': The id of the workstep.
[xml string] 'preparePayloadConfiguration': Configuration for the payload, e.g. which data it should contain
[xml string] 'transactionInformation': Information about the transaction. -
PrepareSignWorkstepDocument_v2
Method to prepare an external signature. Returns the information needed to sign the document.
[string] 'workstepId': The id of the workstep.
[xml string] 'signatureConfig': The configuration for the signature.
[xml string] 'transactionInformation': Information about the transaction. -
RejectWorkstep_v2
Method rejectes the workstep and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[string] 'rejectMessage': Information about why the workstep is rejected.
[xml string] 'transactionInformation': Information about the transaction. -
RejectWorkstep_v3
Method rejectes the workstep and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'rejectConfiguration': The configuration for rejecting.
[xml string] 'transactionInformation': Information about the transaction. -
RequestInformationForSendTransactionCode_v1
Method to request information which is necessary to be handed over to the prepare authentication call for a specific provider which needs additional information e.g. certificate which will be used for authentication
[string] 'workstepId': The id of the workstep.
[xml string] 'requestInformationForSendTransactionCodeConfiguration': Additional configuration for the request authentication call
[xml string] 'transactionInformation': Information about the transaction. -
RetrieveDocumentHashForDocumentBinding_v2
Method returns the document hash of the workstep document.
[string] 'workstepId': The id of the workstep.
[xml string] 'hashConfig': The configuration for the hash calculation.
[xml string] 'transactionInformation': Information about the transaction. -
RetrieveWorkstepModifications_v2
Method returns all modifications applied to the workstep.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
RotateWorkstepDocumentPages_v1
Method rotates one or more pages in a document.
[string] 'workstepId': The id of the workstep.
[xml string] 'rotationConfiguration': The configuration for rotating the pages.
[xml string] 'transactionInformation': Information about the transaction. -
SendTransactionCode_v2
Method to prepare authentication for signing e.g. with transaction code or to prepare authentication for the workstep (e.g. with local certificate)
[string] 'workstepId': The id of the workstep.
[xml string] 'prepareSendTransactionCodeConfiguration': Additional configuration for the authentication
[xml string] 'transactionInformation': Information about the transaction. -
SetOptionalDocumentState_v1
Set the state of an optional document.
[string] 'workstepId': The id of the workstep.
[xml string] 'configuration': The configuration for the state.
[xml string] 'transactionInformation': Information about the transaction. -
SetPassword_v2
Method sets the password for the given document.
[string] 'fileId': The id of the document.
[string] 'password': The password to set.
[xml string] 'transactionInformation': Information about the transaction. -
SetPassword_v3
Method sets the password for the given document.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[string] 'password': The password to set.
[xml string] 'transactionInformation': Information about the transaction. -
SignGenericSigningPluginSignature_v1
Signs a signature via an Generic Signing Plugin.
[string] 'workstepId': The id of the workstep.
[xml string] 'signingConfiguration': Configuration values for the signature
[xml string] 'transactionInformation': Information about the transaction. -
SignWorkstepDocument_v2
Method signs the workstep document and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'signatureConfig': The configuration for the signature.
[xml string] 'transactionInformation': Information about the transaction. -
StartDocumentUpload_v2
[Deprecated: Please check release notes]
Method starts uploading a document and returns the document id.
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[long] 'documentSize': The size of the document.
[xml string] 'transactionInformation': Information about the transaction. -
StartDocumentUpload_v3
Method starts uploading a document and returns the document id.
[string] 'workstepId': The id of the workstep.
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[long] 'documentSize': The size of the document.
[xml string] 'transactionInformation': Information about the transaction. -
StartDocumentUpload_v4
Method starts uploading a document and returns the document id.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[long] 'documentSize': The size of the document.
[xml string] 'transactionInformation': Information about the transaction. -
StartExternalSigningProcess_v1
Method to start an external signing process
[string] 'workstepId': The id of the workstep.
[xml string] 'signingConfiguration': Configuration values for the signature
[xml string] 'transactionInformation': Information about the transaction. -
UndoLastAction_v2
Method undoes the last action and returns new workstep information.
[string] 'workstepId': The id of the workstep.
[xml string] 'transactionInformation': Information about the transaction. -
UpdateLicenseActiveState_v1
Method updates the license active state for an user license.
[xml string] 'updateLicenseActiveStateConfiguration': The license configuration.
[xml string] 'transactionInformation': Information about the transaction. -
UpdateLicenseActiveState_v2
Method updates the license active state for an user license.
[string] 'customizationId': The customization identifier (can be null).
[xml string] 'updateLicenseActiveStateConfiguration': The license configuration.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocumentChunk_v3
[Deprecated: Please check release notes]
Method uploads a chunk for the document with the given id at the given offset.
[string] 'fileId': The id of the document.
[long] 'offset': The offset of the chunk to upload.
[byte[]] 'chunk': The chunk to upload.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocumentChunk_v4
Method uploads a chunk for the document with the given id at the given offset.
[string] 'workstepId': The id of the workstep.
[string] 'fileId': The id of the document.
[long] 'offset': The offset of the chunk to upload.
[byte[]] 'chunk': The chunk to upload.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocumentChunk_v5
Method uploads a chunk for the document with the given id at the given offset.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[string] 'fileId': The id of the document.
[long] 'offset': The offset of the chunk to upload.
[byte[]] 'chunk': The chunk to upload.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocument_v1
[Deprecated: Please check release notes]
Method uploads a document and returns the document id.
[byte[]] 'document': The content of the document.
[string] 'fileName': The name of the document.
[int] 'timeToLive':The time to live of the document in minutes. '0' sets the time to live to forever. -
UploadDocument_v2
[Deprecated: Please check release notes]
Method uploads a document and returns the document id.
[byte[]] 'document': The content of the document.
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocument_v3
Method uploads a document and returns the document id.
[string] 'workstepId': The id of the workstep.
[byte[]] 'document': The content of the document.
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[xml string] 'transactionInformation': Information about the transaction. -
UploadDocument_v4
Method uploads a document and returns the document id.
[string] 'workstepId': The id of the workstep.
[string] 'customizationId': The customization identifier (can be null).
[byte[]] 'document': The content of the document.
[string] 'fileName': The name of the document.
[int] 'timeToLive': The time to live of the document in minutes. '0' sets the time to live to forever.
[xml string] 'transactionInformation': Information about the transaction.