Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Stateless APIs

Date2_CleanupRequest

search

Please Note:

Date2_CleanupRequest

This API performs cleanup of resources.

URL

<http/https>://<host-name>:<Port>/protectappws/services/rest/date2_cleanup

Input Parameters

ParametersDescription
userNameUser name (optional).
passwordPassword associated with the user (optional).
keyNameName of the key to be used for tokenization and detokenization of dates.
dateFormatSchemeRepresents a possible set of date formats.
The supported date format schemes are:
  1. DDMMYYYY (includes all possible java date formats that consist of date, month, and year in four digits)
    The possible formats under this scheme can be dd/MM/yyyy, dd/MMM/yyyy, dd-MM-yyyy hh:mm:ss, and so on.
  2. DDMMYY (includes all possible java date formats that consist of date, month, and year in two digits)
    The possible formats under this scheme can be dd/MM/yy, dd-MM-yy hh:mm:ss, and so on.
  3. MMYYYY (includes all possible java date formats that consist of month and year in four digits)
    The possible formats under this scheme can be MM/yyyy, yyyy-MM, and so on.
  4. MMYY (includes all possible java date formats that consist of month and year in two digits)
    The posible formats under this scheme can be MM/yy, yy-MM, and so on.
startYearThe value of start year must be greater than 999 for yyyy date format.
The value of start year lies in the range from 00-100 for yy date format.
Optional, if preserve parameter is set to Year_Month or Year.
endYearMaximum value of end year is 9999 in yyyy date format.
Maximum value of end year is 100 in yy date format.
Optional, if preserve parameter is set to Year_Month or Year.
tweakDataOptional, if provided, the length of tweak data should be ≤ 256 characters.
The default value is empty string.
preserveRetains the specific part of data that remains unaltered after tokenization. The valid values are:
— NONE (Default)
— MONTH
— YEAR
— YEAR_MONTH
For example, if the date to tokenize is 15-05-2024 and preserve is set to YEAR, then output can be 27-10-2024, where the year (2024) remains unaltered.
certAliasClient certificate alias for making SSL connections (optional).
certPasswordPassword for the provided certificate alias (optional).

Note

The startYear and endYear is mandatory if the preserve type is NONE

Cleanup Sample REST call for cxf

Date2_Cleanup request

    {
        "Date2_CleanupRequest": {
        "userName": "admin",
        "password": "Thales.1",
        "keyName": "tedx",
        "dateFormatScheme": "DDMMYYYY",
        "tweakData": "hkpdmyu74j2m0xluv37vrg5y07rff1ydzq2tlblreysu3y8etx9b8sxq8bnf796vor8uw57pz2kqs4vabdt1wmh91kuzcr655y77hq6vknhfrxzqy95ghuzmbk4l3t52ulkzz5jcjgnl5liqj9v7gmdo7np4a6fe4tcl4ekemtrjbeekw9ccuuhf9yjfyfoetacco1ggfzlvq3rirds558zv52x7kwyzyx4g8qmol9xq5uaprcnsnhvacbxwdk9x",
        "startYear": "1950",
        "endYear": "2050",
        "preserve": "YEAR"
        }
    }

Date2_Cleanup response

    {
        "Date2_CleanupResponse": {
        "cleanupResponse": "Cleanup Successful"
        }
    }

Date2_CleanupRequest SOAP Sample

    <prot:Date2_CleanupRequest>
        <!--Optional:-->
        <userName>admin</userName>
        <!--Optional:-->
        <password>Thales.1</password>
        <keyName>tedx</keyName>
        <dateFormatScheme>DDMMYYYY</dateFormatScheme>
        <!--Optional:-->
        <startYear>1950</startYear>
        <endYear>2050</endYear>
        <!--Optional:-->
        <tweakData>12345678</tweakData>
        <!--Optional:-->
        <preserve>NONE</preserve>
        <!--Optional:-->
        <certAlias></certAlias>
        <!--Optional:-->
        <certPassword></certPassword>
    </prot:Date2_CleanupRequest>

Date2_CleanupRequest Output

    <ns2:Date2_CleanupResponse xmlns:ns2="http://dsws.org/protectappws/">Cleanup Successful</ns2:Date2_CleanupResponse>

Reference

The specifications for the Date2 algorithm are listed here.

On this page