Localisation

Create messages for different locale

Create messages for different locale.

post

/v1/_create

Body

tenantIdstring

Unique tenant id.

RequestInfoany

messagesobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/messages/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"messages":[{}]}'

200

400

200

{}

MessagesResponse as object

update messages for different locale

update messages for different locale.

post

/v1/_update

Body

localestring

Locale of message.

tenantIdstring

Tenant of message.

modulestring

Module of message..

RequestInfoany

messagesobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/messages/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"messages":[{}]}'

200

400

200

{
  "messages": [
    {
      "code": "text",
      "message": "text",
      "module": "text",
      "locale": "text"
    }
  ],
  "responseInfo": {}
}

MessagesResponse as object

delete messages

delete messages

post

/v1/_delete

Body

tenantIdstring

tenant id of message.

RequestInfoany

messagesobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/messages/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"messages":[{}]}'

200

400

200

{
  "successful": true,
  "responseInfo": {}
}

MessagesResponse as object

Get messages by locale and tenantId

Returns all the messages by locale and tenantId.

post

/v1/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for ulb.

localestring · varcharrequired

locale for message.

modulestring · varcharrequired

Module name for message

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/messages/v1/_search?tenantId=text&locale=text&module=text'

200

400

200

[
  {
    "messages": [
      {
        "code": "text",
        "message": "text",
        "module": "text",
        "locale": "text"
      }
    ],
    "responseInfo": {}
  }
]

An array of Messages