PUT api/pinches/{pinchId}/triggerPush

Trigger pushing a pinch to devices

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pinchId

globally unique identifier

Required

Body Parameters

PinchPushDto
NameDescriptionTypeAdditional information
Settings

Collection of UserExternalAppSettingDto

None.

ViewType

PinchViewTypeEnum

None.

Url

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Settings": [
    {
      "Id": "9fd75cf9-de9e-48eb-84c9-bab490a93750",
      "ExternalPinchId": "sample string 2",
      "Description": "sample string 3",
      "ExternalAppId": "sample string 4"
    },
    {
      "Id": "9fd75cf9-de9e-48eb-84c9-bab490a93750",
      "ExternalPinchId": "sample string 2",
      "Description": "sample string 3",
      "ExternalAppId": "sample string 4"
    }
  ],
  "ViewType": 0,
  "Url": "sample string 1"
}

Response Information

Resource Description

PinchPushResultDto
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

FailureMessages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "FailureMessages": [
    "sample string 1",
    "sample string 2"
  ]
}