Class: SetPushDestinationRequest

tibco.objectapi.service.request.SetPushDestinationRequest

new SetPushDestinationRequest(entityType, entityGuid, version, channelType, channelId, name)

Object SetPushDestinationRequest Usage: RestApiService.getOrgModelService().setPushDestination(request, callback);
Parameters:
Name Type Description
entityType string The organization model entity type for which push destinations are being updated.
entityGuid string The GUID for the organization model entity type. Can be obtained using getOrgModel.
version number (Java type: int) The major version for organization model entity type. Can be obtained using listOrgModelVersions.
channelType string Enumerated value defining the channel type (technology) associated with the specified channelId. The valid entries are:
  • openspaceChannel
  • MobileChannel
  • GIChannel
  • EmailChannel

For more information, see "Identifying the Client Channel in a Service Call" in the developer guide.

channelId string Identifies the presentation channel to use when pushing work items. The channel ID is defined when a presentation channel is defined in TIBCO Business Studio. For more information, see the TIBCO Business Studio documentation.
name string The name to be given to the push destination.
Since:
  • 4.0.0

Members

enabled :boolean

Query parameter: 'enabled' (optional) Indicates whether or not the push destination is enabled.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = true

resourceAttr :string

Query parameter: 'resourceattr' (optional) The Resource Attribute from which the push destination will take its value.
Type:
  • string
Since:
  • 4.0.0

value :string

Query parameter: 'value' (optional) Value to assign to the push destination. If the aResourceAttr parameter is supplied, this value is ignored.
Type:
  • string
Since:
  • 4.0.0