Jump to

• Request
• Response
• Examples

Get a message base

get

/services/rest/connect/v1.4/messageBases/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the message base.

Back to Top

Response

Default Response

Body ()

Root Schema : messageBases

Type: object

The editable text string that allows international language support and customization of headings, labels, buttons, and other text in the administration interface and customer portal. It also applies to email messages and notifications.

Show Source

• createdTime: string
  The date and time when the message base was created. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the message base.
• lookupName: string
  Maximum Length: 255

  The name used to look up the message base.
• name: string
  Maximum Length: 120

  Pattern: ^[a-zA-Z]([0-9A-Za-z_]*)$

  The name of the message base.
• updatedTime: string
  The date and time when the message base was last updated. This attribute is read-only.
• usage: object namedIDs-messageBases-usage
  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.
• value: [ "string", "null" ]
  Maximum Length: 300000

  The string value of the message base.

{
    "type":"object",
    "description":"The editable text string that allows international language support and customization of headings, labels, buttons, and other text in the administration interface and customer portal. It also applies to email messages and notifications.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the message base was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[a-zA-Z]([0-9A-Za-z_]*)$",
            "type":"string",
            "description":"The name of the message base.",
            "maxLength":"120"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the message base.",
            "maxLength":"255"
        },
        "value":{
            "type":[
                "string",
                "null"
            ],
            "description":"The string value of the message base.",
            "maxLength":"300000"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the message base was created. This attribute is read-only."
        },
        "usage":{
            "type":"object",
            "description":"The type of data the message base represents.",
            "$ref":"#/definitions/namedIDs-messageBases-usage"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the message base.",
            "maximum":"9223372036854776000"
        }
    }
}

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

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

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"
    }
  ]
}

Back to Top