REST API for Oracle B2C Service

Get an event subscription

get

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

Request

Path Parameters

id(required): integer

The unique identifier of the event subscription.

Response

Default Response

Root Schema : eventSubscriptions

Type: object

The event-based subscription management object that allows external applications to discover objects that can be subscribed.

Show Source

class: string

Maximum Length: 256

Pattern: ^(Contact|Organization|Incident)$

The string which represents the type of object in the ObjectShapeXML.
createdTime: string

The date and time when the event subscription was created. This attribute is read-only.
endPoint: string

Maximum Length: 1333

The URL to post the notification event. Note: If an endpoint is registered as a callback, it should contain the fully qualified domain name. For example: "endpoint" : "https://mydomain-name.com:[port-number]/myEventReceiverService"
eventType: object namedIDs-eventSubscriptions-eventType

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.
id: integer

Minimum Value: 1

Maximum Value: 9223372036854776000

The unique identifier of the event subscription.
integrationUser: object namedIDs-eventSubscriptions-integrationUser

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.
lookupName: string

Maximum Length: 255

The name used to look up the event subscription.
name: string

Maximum Length: 255

Pattern: ^[^ ]*$

The unique name of the event subscription.
objectShapeXml: string

Maximum Length: 349525

The shape of the template object used to send the notification.
objectVersion: object namedIDs-eventSubscriptions-objectVersion

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.
status: object namedIDs-eventSubscriptions-status

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.
updatedTime: string

The date and time when the event subscription was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The event-based subscription management object that allows external applications to discover objects that can be subscribed.",
    "properties":{
        "status":{
            "type":"object",
            "description":"The status of the event subscription.",
            "$ref":"#/definitions/namedIDs-eventSubscriptions-status"
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the event subscription was last updated. This attribute is read-only."
        },
        "endPoint":{
            "type":"string",
            "description":"The URL to post the notification event. Note: If an endpoint is registered as a callback, it should contain the fully qualified domain name. For example: \"endpoint\" : \"https://mydomain-name.com:[port-number]/myEventReceiverService\"",
            "maxLength":"1333"
        },
        "name":{
            "pattern":"^[^\n]*$",
            "type":"string",
            "description":"The unique name of the event subscription.",
            "maxLength":"255"
        },
        "eventType":{
            "type":"object",
            "description":"The types of event such as Create, Update, or Destroy.",
            "$ref":"#/definitions/namedIDs-eventSubscriptions-eventType"
        },
        "objectShapeXml":{
            "type":"string",
            "description":"The shape of the template object used to send the notification.",
            "maxLength":"349525"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the event subscription.",
            "maxLength":"255"
        },
        "objectVersion":{
            "type":"object",
            "description":"The Connect version of the object to be sent in the notification.",
            "$ref":"#/definitions/namedIDs-eventSubscriptions-objectVersion"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the event subscription.",
            "maximum":"9223372036854776000"
        },
        "integrationUser":{
            "type":"object",
            "description":"The credentials and connection method to use for the event subscription.",
            "$ref":"#/definitions/namedIDs-eventSubscriptions-integrationUser"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the event subscription was created. This attribute is read-only."
        },
        "class":{
            "pattern":"^(Contact|Organization|Incident)$",
            "type":"string",
            "description":"The string which represents the type of object in the ObjectShapeXML.",
            "maxLength":"256"
        }
    }
}

Nested Schema : namedIDs-eventSubscriptions-eventType

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

Nested Schema : namedIDs-eventSubscriptions-integrationUser

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

Nested Schema : namedIDs-eventSubscriptions-objectVersion

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

Nested Schema : namedIDs-eventSubscriptions-status

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

Examples

Use GET with the following syntax to retrieve data for an event subscription object:

https://your_site_interface/services/rest/connect/version/eventSubscriptions/event_subscription_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10004

Response body example

{
  "id": 10004,
  "lookupName": "MyContactCreateSubscription",
  "createdTime": "2016-03-22T13:44:30.000Z",
  "updatedTime": "2016-03-22T13:44:30.000Z",
  "class": "Contact",
  "endPoint": "https://myEventReceiverService",
  "eventType": {
    "id": 1,
    "lookupName": "Create"
  },
  "integrationUser": {
    "id": 1,
    "lookupName": "ICS Integration"
  },
  "name": "MyContactCreateSubscription",
  "objectShapeXml": "<n0:TriggeringObject xmlns:n0="urn:messages.ws.rightnow.com/v1_4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="n1:Contact"
    xmlns:n1="urn:objects.ws.rightnow.com/v1_4"><n1:Notes></n1:Notes></n0:TriggeringObject>",
  "objectVersion": {
    "id": 100300,
    "lookupName": "v1.4"
  },
  "status": {
    "id": 1,
    "lookupName": "Active"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10004"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10004"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
       eventSubscriptions",
      "mediaType": "application/schema+json"
    }
  ]
}