REST API - updatePushDestination - passing parameters

The table summarizes the REST API - updatePushDestination.

Request

Format 
PUT <baseurl>/orgmodel/pushdestination/<entitytype>/<entityguid>/<version>/<channeltype>/<channelid>/<name>
Path parameters
  • entitytype: The organization model entity type for which push destinations are being updated.
  • entityguid: The GUID for the organization model entity type. Can be obtained using getOrgModel and getResource.
  • version: The major version for organization model entity type. Can be obtained using listOrgModelVersions.
  • channeltype: An enumerated value associated with that channel type, for example, EmailChannel, MobileChannel, and openspaceChannel. For more information, see Identifying the Client Channel in a Service Call.
  • channelid: Uniquely 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, as well as Identifying the Client Channel in a Service Call and "Configuring the Email Presentation Channel" in the TIBCO ActiveMatrix BPM - BPM Administration guide.
  • name: The name to be given to the push destination.
Query parameters
  • value=string (optional): Value to assign to the push destination. If the resourceattr parameter is supplied, this value is ignored.
  • resourceattr=string (optional): The Resource Attribute from which the push destination will take its value.
  • enabled=boolean (default = true): Indicates whether or not the push destination is enabled.

Response

JSON If successful, returns 200 OK in the response header, and an empty response body.
XML If successful, returns 200 OK in the response header, and an empty response body.

Example

Request 
PUT <baseurl>/orgmodel/pushdestination/RESOURCE/0D954794-9DEF-4B99-9F12-F0B7A96D0F8E/-1/EmailChannel/openspaceEmailPush_DefaultChannel/Email?value=Support@megacorp.com