Retrieve an instance of messageBases

get

/services/rest/connect/latest/messageBases/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
Contains information about the message base within the system.
Root Schema : messageBases
Type: object
Contains information about the message base within the system.
Show Source
Nested Schema : namedIDs-messageBases-usage
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a specific custom message base:

https://your_site_interface/services/rest/connect/version/messageBases/message_base_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/messageBases/1000001

Response body example

{
  "id": 1000001,
  "lookupName": "CUSTOM_MSG_test",
  "name": "CUSTOM_MSG_test",
  "usage": {
    "id": 1,
    "lookupName": "Plain"
  },
  "value": "test message base",
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/messageBases/1000001"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/messageBases/1000001"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/messageBases",
      "mediaType": "application/schema+json"
    }
  ]
}