Methods
GetCaseList
Retrieves the case list based on the specified criteria. The case list will only contain cases where one or more parts of the case are not marked as collected. The case list will only contain cases that the user used at login has access to.
Parameter set-up Expand |
---|
|
ParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | Includecollected | Bool | Determines whether cases should be collected even if the case and all parts of it are marked as collected. |
OutputThis method returns a |
sequence the object contains the cases that can be collected, cf. the specified parameters. |
GetCaseIdList
Retrieves an array of case identities based on the specified criteria. The array will only contain cases where one or more parts of the case are not marked as collected. The array will only contain cases that the user used at login has access to.
Parameter set-up Expand |
---|
|
Parameters Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | Includecollected | Bool | Determines whether cases should be collected even if the case and all parts of it are marked as collected. |
OutputThis method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters. |
GetCaseList001
Retrieves the case list based on the specified criteria. The content of the case list can be varied to only contain cases where there are no collected documents, parties and actions.
Parameter set-up Expand |
---|
|
Parameters Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | WithNewDocuments | Bool | Determines whether the case list should contain cases where there are not collected documents. | WithNewParts | Bool | Determines whether the case list should contain cases where there are no collected parties. | WithNewEvents | Bool | Determines whether the case list should contain cases where there are no collected actions. | Includecollected | Bool | Determines whether cases should be collected even if the case and all parts of it are marked as collected. |
OutputThis method returns a |
sequence the object that contains the cases objects that can be collected, cf. the specified parameters. |
GetCaseIdList001
Retrieves an array of case identities based on the specified criteria. The array can be varied to only contain cases where there are no collected documents, parties and actions.
Parameter set-up Expand |
---|
|
ParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | WithNewDocuments | Bool | Determines whether the case list should contain cases where there are not collected documents. | WithNewParts | Bool | Determines whether the case list should contain cases where there are no collected parties. | WithNewEvents | Bool | Determines whether the case list should contain cases where there are no collected actions. | Includecollected | Bool | Determines whether cases should be collected even if the case and all parts of it are marked as collected. |
OutputThis method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters. |
GetCaseList002
Retrieves the case list based on the specified criteria. The content of the case list can be varied by searching in the case name and/or KLE.
Parameter set-up Expand |
---|
|
ParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | CaseNameContains | String | Filtering by case name. | KLEStartsWith | String | Filtering on KLE. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | Includecollected | Bool | Determines whether the case list should contain cases that are already marked as collected. |
OutputThis method returns a |
sequence the object contains the cases that can be collected, cf. the specified parameters. |
GetCaseIdList002
Retrieves an array of case identities based on the specified criteria. The array can be varied by searching in case name and/or KLE.
Parameter set-up Expand |
---|
|
ParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | CaseNameContains | String | Filtering by case name. | KLEStartsWith | String | Filtering on KLE. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | Includecollected | Bool | Determines whether the case list should contain cases that are already marked as collected. |
OutputThis method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters. |
GetKMDOperaCaseList
Retrieves the case list based on the specified criteria, where ExternalMetadata.ExternalMetadataOwner is set to KMDOpera. The content of the case list can be varied to only contain cases where there are no collected documents, parties and actions.
Parameter set-up Expand |
---|
|
ParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining which cases can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | OriginSystemType | OriginSystemType | Indication of which |
|
origin system Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | FromDateTime | DateTime | Minimum date from which cases are to be collected. | ToDateTime | DateTime | Maximum date for which cases are to be collected. | WithNewDocuments | Bool | Determines whether the case list should contain cases where there are not collected documents. | WithNewParts | Bool | Determines whether the case list should contain cases where there are no collected parties. | WithNewEvents | Bool | Determines whether the case list should contain cases where there are no collected actions. |
OutputThis method returns a |
sequence the object that contains the cases objects that can be collected, cf. the specified parameters. |
GetCaseById
Retrieves the case based on the provided CaseId. It is a precondition that the user has the proper set access rights.
Parameter set-upParametersName | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the case can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | CaseId | Long | ID of the case to be collected. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. |
OutputThis method returns an object of type Case. |
MarkCaseCollected
Marks the case as collected by the user.
Expand |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the case can be marked as collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | CaseId | Long | ID of the case to be marked as collected. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | ExternalId | String | Any. ID from the data recipient’s system. | Recursive | Bool | Indication of whether all parts of the case (documents, parties and actions) should also be marked as collected. |
OutputThis method has no output. |
RevokeCaseCollected
Revokes the case collected by the user.
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the case’s marking as collected can be revoked. |
|
Passwords:Password | String | Password for the user |
|
in question. | CaseId | Long | ID of the case where the marking as collected is to be revoked. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | Revocation Reason | String | Can contain a description of why the case’s marking as collected is revoked. | Recursive | Bool | Indication of whether all the case’s shared (documents, parties and actions) markings as collected must also be revoked. |
OutputThis method has no output. |
GetDocumentContent
Gets the content of the document to the case.
Expand |
---|
|
Name | Type | Description of the |
|
User’s nameUsername | String | User name for login and checking rights in relation to whether the document content can be collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | DocumentId | Long | ID of document whose content is to be collected. |
OutputThis method returns an array of bytes representing the content of the document. |
MarkDocumentCollected
Marks the document collected on the case by the user.
Expand |
---|
title | MarkDocumentCollected |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the document can be marked as collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | DocumentId | Long | ID of document to be marked as collected. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | ExternalId | String | Any. ID from the data recipient’s system. |
OutputThis method has no output. |
RevokeDocumentCollected
Revokes the document collected on the case by the user.
title | RevokeDocumentCollected |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the document’s marking as collected can be revoked. |
|
Passwords:Password | String | Password for the user |
|
in question. | DocumentId | Long | ID of the document where the marking as collected is to be revoked. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | Revocation Reason | String | Can contain a description of why the document’s marking as collected is revoked. |
OutputThis method has no output. |
MarkEventCollected
Marks the event collected on the case by the user.
Expand |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the action can be marked as collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | EventId | Long | ID for action to be marked as collected. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | ExternalId | String | Any. ID from the data recipient’s system. |
OutputThis method has no output. |
RevokeEventCollected
Revokes the event collected on the case by the user.
Expand |
---|
title | RevokeEventCollected |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the action’s marking as collected can be revoked. |
|
Passwords:Password | String | Password for the user |
|
in question. | EventId | Long | ID of the action where the marking as collected is to be revoked. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | Revocation Reason | String | Can contain a description of why the action’s marking as collected is revoked. |
OutputThis method has no output. |
MarkPartCollected
Marks the part collected on the case by the user.
MarkPartCollected |
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the party can be marked as collected. |
|
Passwords:Password | String | Password for the user |
|
in question. | PartId | Long | ID for party to be marked as collected. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | ExternalId | String | Any. ID from the data recipient’s system. |
OutputThis method has no output. |
RevokeEventCollected
InputRevokes the event collected on the case by the user.
Expand |
---|
title | RevokeEventCollected |
---|
|
Name | Type | Description of the |
|
User’s nameUser name check rights in relation to access-rights, determining whether the party’s marking as collected can be revoked. |
|
Passwords:Password | String | Password for the user |
|
in question. | PartId | Long | ID of the party where the marking as collected is to be revoked. | ExternalSystemType | ExternalSystemType | Indication of which system the data recipient calls the method with. | Revocation Reason | String | Can contain a description of why the party’s marking as collected is revoked. |
OutputThis method has no output. |