Service: DataExportService
Version: 1_0 (other versions, change log, null) Latest frozen version. Base by default all your developments on this one.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnai/external-remoting/com.secutix.service.export.v1_0.DataExportService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnai/backend-apis/dataExportService/v1_0/{methodName} Replace {methodName} for the desired method name as shown below.
To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.
For further documentation and examples, please check in Platform Website.A public service to execute data exports associated to previously defined export queries stored in SecuTix and associated with an export ket.
This service is not intended to be called to extract big amounts of data at once.
If such a need arises, please focus on webhooks or flat file exports.
Methods:
- executeExport: Executes an export associated with a given (mandatory) export key.
- flagItems: Marks the items passed as elementIds with the flagDate.
- getAvailableExports: Lists the available exports that can be called from this service, with a list of parameters.
- getFlaggingStatus: Retrieves the flagging status of the elements passed in parameter.
- retrieveGeneratedFileContent: Retrieves the content of a file generated through a flat file export.
- unFlagItems: Unmark the items passed as elementIds.
executeExport
Executes an export associated with a given (mandatory) export key. This execution can return in_progress and follow SecuTix asynchronous processes.
Parameters
| requestId | Integer | requestId for asynchronous calls. Pass null by default, reinject the requestId proposed by an export in progress. |
| exportKey | String | Mandatory
key of the export. |
| dateFrom | Date | if the query associated with key supports that kind of value, dateFrom may be used to paginate according to export dates. |
| dateTo | Date | |
| parameters | List of Parameter | a list of parameters as demanded by the query associated to the key. Depends on the query. |
| nbMaxResults | Integer | Nb max results. If omitted, default value will be 1000. All values above 1000 will be set to 1000. |
| Parameter |
|
| name | String | |
| value | String | |
Return value
| ExportResult |
|
| exportDate | Date | |
| exportedElements | List of ExportedElement | |
| requestState | AsynchronousMethodResult.
AsynchronousMethodState | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| NameValue |
|
| name | String | |
| value | String | |
flagItems
Marks the items passed as elementIds with the flagDate. This date can be used to mark processed items.
if itemKind is INVOICE, resp PAYMENT, elementIds expected will have to be invoiceIds, resp. paymentIds.
The max number of elements that can be flagged in one call is 10000.
Parameters
| requestId | Integer | |
| itemKind | (INVOICE|PAYMENT|CONTACT|
GENERIC) | Mandatory
|
| elementsIds | List of Long | Mandatory
|
| flagDate | Date | Mandatory
|
Return value
| FlagResult |
|
| flagData | List of FlagData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| FlagData |
|
| elementIds | List of Long | |
| flaggingDate | Date | |
getAvailableExports
Lists the available exports that can be called from this service, with a list of parameters.
Parameters
Return value
| AvailableExportsResult |
|
| exports | List of Export | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| Export |
|
| exportKey | String | |
| exportParameterNames | List of String | |
getFlaggingStatus
Retrieves the flagging status of the elements passed in parameter.
if itemKind is INVOICE, resp PAYMENT, elementIds expected will have to be invoiceIds, resp. paymentIds.
The max number of elements that can be flagged in one call is 10000.
Parameters
| requestId | Integer | |
| itemKind | (INVOICE|PAYMENT|CONTACT|
GENERIC) | Mandatory
|
| elementsIds | List of Long | Mandatory
|
Return value
FlagResult
retrieveGeneratedFileContent
Retrieves the content of a file generated through a flat file export.
Parameters
| FileCriteria |
| This criteria allows to find the file properly. |
| adapterName | String | |
| fileGenerationDate | Date | |
| module | (EXPORTS|ACCESS_CONTROL) | Mandatory
|
| organizationCode | String (8) | If not defined, will consider the organization related to the operator used to connect. |
Return value
| FileContentResult |
|
| fileContentBase64 | String | File content, encoded in base64 |
| fileName | String | Filename |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
unFlagItems
Unmark the items passed as elementIds.
if itemKind is INVOICE, resp PAYMENT, elementIds expected will have to be invoiceIds, resp. paymentIds.
The max number of elements that can be flagged in one call is 10000.
Parameters
| requestId | Integer | |
| itemKind | (INVOICE|PAYMENT|CONTACT|
GENERIC) | Mandatory
|
| elementsIds | List of Long | Mandatory
|
Return value
FlagResult