Publish And Sync Ui Events

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"LatestKnownEventId\": 123,\n  \"PublishEvents\": [\n    {\n      \"EventId\": 123,\n      \"EventName\": \"<string>\",\n      \"EntityType\": \"<string>\",\n      \"EntityKey\": 123,\n      \"AssociateId\": 123,\n      \"AssociateName\": \"<string>\",\n      \"EventDateTime\": \"2023-11-07T05:31:56Z\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Metrics\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": 123\n    }\n  ],\n  \"TicketVersions\": [\n    {\n      \"TicketId\": 123,\n      \"LastChanged\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}],
    TicketVersions: [{TicketId: 123, LastChanged: '2023-11-07T05:31:56Z'}]
  })
};

fetch('http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'LatestKnownEventId' => 123,
    'PublishEvents' => [
        [
                'EventId' => 123,
                'EventName' => '<string>',
                'EntityType' => '<string>',
                'EntityKey' => 123,
                'AssociateId' => 123,
                'AssociateName' => '<string>',
                'EventDateTime' => '2023-11-07T05:31:56Z',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Metrics' => [
        [
                'Name' => '<string>',
                'Value' => 123
        ]
    ],
    'TicketVersions' => [
        [
                'TicketId' => 123,
                'LastChanged' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents"

payload = {
    "LatestKnownEventId": 123,
    "PublishEvents": [
        {
            "EventId": 123,
            "EventName": "<string>",
            "EntityType": "<string>",
            "EntityKey": 123,
            "AssociateId": 123,
            "AssociateName": "<string>",
            "EventDateTime": "2023-11-07T05:31:56Z",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Metrics": [
        {
            "Name": "<string>",
            "Value": 123
        }
    ],
    "TicketVersions": [
        {
            "TicketId": 123,
            "LastChanged": "2023-11-07T05:31:56Z"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}],
    TicketVersions: [{TicketId: 123, LastChanged: '2023-11-07T05:31:56Z'}]
  })
};

fetch('http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Events": [
    {
      "EventId": 123,
      "EventName": "<string>",
      "EntityType": "<string>",
      "EntityKey": 123,
      "AssociateId": 123,
      "AssociateName": "<string>",
      "EventDateTime": "2023-11-07T05:31:56Z",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TicketStates": [
    {
      "TicketId": 123,
      "LastChanged": "2023-11-07T05:31:56Z",
      "IsStale": true,
      "ChangedById": 123,
      "ChangedByName": "<string>"
    }
  ]
}

Publish And Sync Ui Events

Publish zero or more events and return any new events since the given event id, exactly like PublishAndRetrieveUiEvents — and additionally answer, for each ticket version the client supplies, whether that ticket has changed since (and by whom).

Requested tickets the user cannot see are omitted from the answer NsApiSlow threshold: 5000 ms. ## Experimental: ## This method is experimental, subject to change, and not intended for partners.

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"LatestKnownEventId\": 123,\n  \"PublishEvents\": [\n    {\n      \"EventId\": 123,\n      \"EventName\": \"<string>\",\n      \"EntityType\": \"<string>\",\n      \"EntityKey\": 123,\n      \"AssociateId\": 123,\n      \"AssociateName\": \"<string>\",\n      \"EventDateTime\": \"2023-11-07T05:31:56Z\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Metrics\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": 123\n    }\n  ],\n  \"TicketVersions\": [\n    {\n      \"TicketId\": 123,\n      \"LastChanged\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}],
    TicketVersions: [{TicketId: 123, LastChanged: '2023-11-07T05:31:56Z'}]
  })
};

fetch('http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'LatestKnownEventId' => 123,
    'PublishEvents' => [
        [
                'EventId' => 123,
                'EventName' => '<string>',
                'EntityType' => '<string>',
                'EntityKey' => 123,
                'AssociateId' => 123,
                'AssociateName' => '<string>',
                'EventDateTime' => '2023-11-07T05:31:56Z',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Metrics' => [
        [
                'Name' => '<string>',
                'Value' => 123
        ]
    ],
    'TicketVersions' => [
        [
                'TicketId' => 123,
                'LastChanged' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents"

payload = {
    "LatestKnownEventId": 123,
    "PublishEvents": [
        {
            "EventId": 123,
            "EventName": "<string>",
            "EntityType": "<string>",
            "EntityKey": 123,
            "AssociateId": 123,
            "AssociateName": "<string>",
            "EventDateTime": "2023-11-07T05:31:56Z",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Metrics": [
        {
            "Name": "<string>",
            "Value": 123
        }
    ],
    "TicketVersions": [
        {
            "TicketId": 123,
            "LastChanged": "2023-11-07T05:31:56Z"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}],
    TicketVersions: [{TicketId: 123, LastChanged: '2023-11-07T05:31:56Z'}]
  })
};

fetch('http://localhost:56350/api/v1/Agents/ViewState/PublishAndSyncUiEvents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Events": [
    {
      "EventId": 123,
      "EventName": "<string>",
      "EntityType": "<string>",
      "EntityKey": 123,
      "AssociateId": 123,
      "AssociateName": "<string>",
      "EventDateTime": "2023-11-07T05:31:56Z",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TicketStates": [
    {
      "TicketId": 123,
      "LastChanged": "2023-11-07T05:31:56Z",
      "IsStale": true,
      "ChangedById": 123,
      "ChangedByName": "<string>"
    }
  ]
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

LatestKnownEventId, PublishEvents, Metrics, TicketVersions

PublishAndSyncUiEvents: Publish zero or more events and return any new events since the given event id, exactly like PublishAndRetrieveUiEvents — and additionally answer, for each ticket version the client supplies, whether that ticket has changed since (and by whom). Requested tickets the user cannot see are omitted from the answer

LatestKnownEventId

integer<int32>

PublishEvents

object[]

Show child attributes

Metrics

object[]

Show child attributes

TicketVersions

object[]

Show child attributes

Response

The combined answer of one live UI sync call: new UI events, plus the sync state of the tickets the client asked about. Carrier object for LiveUiSyncResult.

Events

object[]

New events since the given event id — the same content the PublishAndRetrieveUiEvents operation returns.

Show child attributes

TicketStates

object[]

Sync state of each requested ticket the user is allowed to see. Requested tickets the user cannot see are omitted.

Show child attributes