PrxMetaSheetUserCommentsCRUD: Operation

SheetUserComments PrxMetaSheetUserCommentsCRUD(string mon, SheetUserCommentRequest tArg)

Parameters

Description

The PrxMetaSheetUserCommentsCRUD operation is used to work with data cell comments.

Comments

The operation can be used to create, get or delete data cell comments. It is relevant if a standard cube, in which storing of comments is enabled, is used as a report's data source. To execute the operation, in the mon field specify moniker in the format: Regular report instance moniker!Sheets!Sheet key, and in the tArg field specify required parameters for working with comments. Moniker of regular report instance can be obtained on executing the OpenPrxMeta operation.

The operation results in the collection of comments that is created after executing operations with cell comment.

Example

Below is the example of adding a comment for data cell. The request contains regular report sheet moniker and parameters of the added comment. The response contains information about the added comment.

SOAP JSON C#

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<mon xmlns="">KGBKAFPLHHHFGOAEODMMGFGHIBKEPFOEILFBAIBFFGGFJCEI!M!S!PMGBFELPLHHHFGOAEAAMGLFFBDLECLELEBJOMIJLKCLINAMNB!Sheets!1</mon>

<text>Data is outdated, refresh is required.</text>

</tArg>

</PrxMetaSheetUserCommentsCRUD>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<it>

<text>Data is outdated, refresh is required.</text>

<user>the ADMIN user</user>

<it>

</it>

</coords>

</it>

</its>

</PrxMetaSheetUserCommentsCRUDResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "PrxMetaSheetUserCommentsCRUD" : 
  {
   "mon" : "KGBKAFPLHHHFGOAEODMMGFGHIBKEPFOEILFBAIBFFGGFJCEI!M!S!PMGBFELPLHHHFGOAEAAMGLFFBDLECLELEBJOMIJLKCLINAMNB!Sheets!1",
   "tArg" : 
    {
     "row" : "2",
     "col" : "2",
     "text" : "Data is outdated, refresh is required.",
     "operation" : "Add"
    }
  }
}

JSON response:

{
 "PrxMetaSheetUserCommentsCRUDResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "k" : "21",
         "vis" : "1",
         "text" : "Data is outdated, refresh is required.",
         "ts" : "2025-04-08T17:48:42.706",
         "user" : "The ADMIN user",
         "rights" : "65535",
         "coords" : 
          {
           "it" : 
            {
             "row" : "2",
             "col" : "2"
            }
          }
        }
      ]
    }
  }
}

public static SheetUserComments PrxMetaSheetUserCommentsCRUD(string moniker, uint sheetKey)
        {
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tAdd = new PrxMetaSheetUserCommentsCRUD()
    {
        tArg = new SheetUserCommentRequest()
        {
            operation = ListOperation.Add,
            row = 2,
            col = 2,
            text = "Data is outdated, refresh is required."
        },
        mon = moniker + "!Sheets!" + sheetKey
    };
    // Add a comment for data cell
    var result = somClient.PrxMetaSheetUserCommentsCRUD(tAdd);
    return result;
}

PrxMetaSheetUserCommentsCRUD

Syntax