Skip to main content

Customization service

Overview​

Customization service is backend service to allow manage customization value per Environment (Master), Tenant and Organization (Mandant). On every level of customization can gets or sets customization value as simple text, localized text, file with any complex content. In one code can combine all possible value storage if you need.

  • Customization (user,)
    • OpenAPI specification: https://[HostName]/api/asol/customization/swagger

Note: OpenAPI specification (Swagger) is disabled on production stage. You can gets it from development stages only.

Dependencies between services

Prerequisites​

Keyfeatures​

  • Frontend customization via call Customization service backend API.
  • Backend customization via call Customization service backend API.

How can customize something on frontend​

Gets existings customization (all or one by code)​

[GET] /api/v1/Customizations

  • (optional) parameter ApplicationCode - Filter output to specified application code
  • (optional) parameter Code - Filter output to specified code
  • (optional) parameter evaluate
    • (Default) True means that the customization is evaluated and you get one evaluated value for the combination of Code and ApplicationCode.
    • False means that you get all the values of the security-appropriate settings without evaluating what values, even those that are overwritten.

Alternative example:

  • Alternative example /Customizations?ApplicationCode=ASOLEU-HCM-AP-&Code=KPI-Label&evaluate=false

Create or update customization​

[PUT] /api/v1/Customizations/{applicationCode}/{code}

body example model:

{
  "applicationCode": "string", // expected application code for customization
  "code": "string", // expected unique code within application code for customization
  "valueLevel": "Master", // customization level can be Master, Tenant, Organization (as mandant) 
  "documentId": "string", // custom documentId, can be null, backend automaticaly determine right value from security token.
  "simpleValue": "string", //  you can setup your own simple string as customization value
  "localizedValue": { // you can setup localized string value as customization value
    "values": [
      {
        "locale": "string",
        "value": "string"
      }
    ]

  },
  // If you upload a value to Content Manager, you can set uploadId and the file name for the correct file reference as the customization value
  "valueUploadId": "string",
  "valueUploadFileName": "string"
}