InteropTopicSubscription

Represents a subscription to an interoperability topic. This object is available in API version 64.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

ChannelIdentifier

Type: textarea
Properties: Create, Nillable, Update
Description: The identifier of the channel to which notifications are sent, such as an URL or email.

ChannelTypeCodeId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The code representing the type of channel used to send notifications for the interoperability topic subscription.

This field is a relationship field.
Relationship Name: ChannelTypeCode
Refers To: CodeSet

CheckInInterval

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum interval, in seconds, before a check-in notification is sent to keep the subscription active when no new events occur.

EffectiveEndDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The last date when the interoperability topic subscription is effective.

EffectiveStartDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The first date when the interoperability topic subscription is effective.

InteropTopicId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The interoperability topic that’s being subscribed to.

This field is a relationship field.
Relationship Name: InteropTopic
Refers To: InteropTopic

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when the interoperability topic subscription record was last referenced.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when the interoperability topic subscription record was last viewed.

MaximumEventCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum number of events that can be bundled in a notification.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the interoperability topic subscription.

NotificationTimeout

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum amount of time, in seconds, to deliver a notifcation for the subscription.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The user who owns the interoperability topic subscription record.

This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

PayloadContentType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of content included in the notification payload.
Possible values:
- EMPTY—Empty
- FULL_RESOURCE—Full Resource
- ID_ONLY—ID Only

PayloadFormatType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the format in which the notification payload for the subscription is sent.

Reason

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason for the interoperability topic subscription.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The status of the interoperability topic subscription.
Possible values:
- ACTIVE—Active
- ENTERED_IN_ERROR—Entered in Error
- ERROR—Error
- OFF—Off
- REQUESTED—Requested

SubscribedById

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The subscriber to the interoperability topic.

This field is a polymorphic relationship field.
Relationship Name: SubscribedBy
Refers To: Account, HealthcareProvider

SubscriberIdentifier

Type: textarea
Properties: Create, Nillable, Update
Description: The unique identifier of the subscriber.

SubscriberSystemIdentifier

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The unique identifier of the subscriber system.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

InteropTopicSubscriptionChangeEvent: Change events are available for the object.
InteropTopicSubscriptionFeed: Feed tracking is available for the object.
InteropTopicSubscriptionHistory: History is available for tracked fields of the object.
InteropTopicSubscriptionShare: Sharing is available for the object.