digitaluapi

<back to all web services

EditTableRecordRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/scadmeta/tables/{TablesId}/editEdit Table Records
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class EditTableRecordRequest implements JsonSerializable
{
    public function __construct(
        /** @description Table id */
        // @ApiMember(Description="Table id", IsRequired=true)
        /** @var int */
        public int $TablesId=0,

        /** @description Parameter list */
        // @ApiMember(Description="Parameter list")
        /** @var array<string,Object>|null */
        public ?array $ParameterList=null,

        /** @description Global parameter list */
        // @ApiMember(Description="Global parameter list")
        /** @var array<string,Object>|null */
        public ?array $GlobalParamList=null,

        /** @description View id */
        // @ApiMember(Description="View id")
        /** @var int|null */
        public ?int $ViewId=null,

        /** @description Whether or not to refresh the cache */
        // @ApiMember(Description="Whether or not to refresh the cache")
        /** @var bool|null */
        public ?bool $RefreshCache=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TablesId'])) $this->TablesId = $o['TablesId'];
        if (isset($o['ParameterList'])) $this->ParameterList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['ParameterList']);
        if (isset($o['GlobalParamList'])) $this->GlobalParamList = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['GlobalParamList']);
        if (isset($o['ViewId'])) $this->ViewId = $o['ViewId'];
        if (isset($o['RefreshCache'])) $this->RefreshCache = $o['RefreshCache'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TablesId)) $o['TablesId'] = $this->TablesId;
        if (isset($this->ParameterList)) $o['ParameterList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->ParameterList);
        if (isset($this->GlobalParamList)) $o['GlobalParamList'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->GlobalParamList);
        if (isset($this->ViewId)) $o['ViewId'] = $this->ViewId;
        if (isset($this->RefreshCache)) $o['RefreshCache'] = $this->RefreshCache;
        return empty($o) ? new class(){} : $o;
    }
}

PHP EditTableRecordRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /scadmeta/tables/{TablesId}/edit HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditTableRecordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <GlobalParamList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </GlobalParamList>
  <ParameterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ParameterList>
  <RefreshCache>false</RefreshCache>
  <TablesId>0</TablesId>
  <ViewId>0</ViewId>
</EditTableRecordRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />