digitaluapi

<back to all web services

MetaQueriesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/scadmeta/meta_queries
<?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 MetaQueriesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Id=null,

        // @DataMember(Order=2)
        /** @var int|null */
        public ?int $DbTechnologiesId=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Description=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $CommandText=null,

        // @DataMember(Order=5)
        /** @var int|null */
        public ?int $CommandTypesId=null,

        // @DataMember(Order=6)
        /** @var bool|null */
        public ?bool $CacheResult=null,

        // @DataMember(Order=7)
        /** @var int|null */
        public ?int $CachetimeInSeconds=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $QueryTypesId=null,

        // @DataMember(Order=9)
        /** @var int|null */
        public ?int $DbTechnologyTemplatesId=null,

        // @DataMember(Order=10)
        /** @var DateTime|null */
        public ?DateTime $LastModifiedDate=null,

        // @DataMember(Order=11)
        /** @var string|null */
        public ?string $RowVersionGuid=null,

        // @DataMember(Order=12)
        /** @var bool|null */
        public ?bool $IsEnabled=null,

        // @DataMember(Order=13)
        /** @var int|null */
        public ?int $ConnectionsId=null,

        // @DataMember(Order=15)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['DbTechnologiesId'])) $this->DbTechnologiesId = $o['DbTechnologiesId'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['CommandText'])) $this->CommandText = $o['CommandText'];
        if (isset($o['CommandTypesId'])) $this->CommandTypesId = $o['CommandTypesId'];
        if (isset($o['CacheResult'])) $this->CacheResult = $o['CacheResult'];
        if (isset($o['CachetimeInSeconds'])) $this->CachetimeInSeconds = $o['CachetimeInSeconds'];
        if (isset($o['QueryTypesId'])) $this->QueryTypesId = $o['QueryTypesId'];
        if (isset($o['DbTechnologyTemplatesId'])) $this->DbTechnologyTemplatesId = $o['DbTechnologyTemplatesId'];
        if (isset($o['LastModifiedDate'])) $this->LastModifiedDate = JsonConverters::from('DateTime', $o['LastModifiedDate']);
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['ConnectionsId'])) $this->ConnectionsId = $o['ConnectionsId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->DbTechnologiesId)) $o['DbTechnologiesId'] = $this->DbTechnologiesId;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->CommandText)) $o['CommandText'] = $this->CommandText;
        if (isset($this->CommandTypesId)) $o['CommandTypesId'] = $this->CommandTypesId;
        if (isset($this->CacheResult)) $o['CacheResult'] = $this->CacheResult;
        if (isset($this->CachetimeInSeconds)) $o['CachetimeInSeconds'] = $this->CachetimeInSeconds;
        if (isset($this->QueryTypesId)) $o['QueryTypesId'] = $this->QueryTypesId;
        if (isset($this->DbTechnologyTemplatesId)) $o['DbTechnologyTemplatesId'] = $this->DbTechnologyTemplatesId;
        if (isset($this->LastModifiedDate)) $o['LastModifiedDate'] = JsonConverters::to('DateTime', $this->LastModifiedDate);
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->ConnectionsId)) $o['ConnectionsId'] = $this->ConnectionsId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class MetaQueriesAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Id=null,

        // @DataMember(Order=2)
        /** @var int|null */
        public ?int $DbTechnologiesId=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Description=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $CommandText=null,

        // @DataMember(Order=5)
        /** @var int|null */
        public ?int $CommandTypesId=null,

        // @DataMember(Order=6)
        /** @var bool|null */
        public ?bool $CacheResult=null,

        // @DataMember(Order=7)
        /** @var int|null */
        public ?int $CachetimeInSeconds=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $QueryTypesId=null,

        // @DataMember(Order=9)
        /** @var int|null */
        public ?int $DbTechnologyTemplatesId=null,

        // @DataMember(Order=10)
        /** @var DateTime|null */
        public ?DateTime $LastModifiedDate=null,

        // @DataMember(Order=11)
        /** @var string|null */
        public ?string $RowVersionGuid=null,

        // @DataMember(Order=12)
        /** @var bool|null */
        public ?bool $IsEnabled=null,

        // @DataMember(Order=13)
        /** @var int|null */
        public ?int $ConnectionsId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['DbTechnologiesId'])) $this->DbTechnologiesId = $o['DbTechnologiesId'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['CommandText'])) $this->CommandText = $o['CommandText'];
        if (isset($o['CommandTypesId'])) $this->CommandTypesId = $o['CommandTypesId'];
        if (isset($o['CacheResult'])) $this->CacheResult = $o['CacheResult'];
        if (isset($o['CachetimeInSeconds'])) $this->CachetimeInSeconds = $o['CachetimeInSeconds'];
        if (isset($o['QueryTypesId'])) $this->QueryTypesId = $o['QueryTypesId'];
        if (isset($o['DbTechnologyTemplatesId'])) $this->DbTechnologyTemplatesId = $o['DbTechnologyTemplatesId'];
        if (isset($o['LastModifiedDate'])) $this->LastModifiedDate = JsonConverters::from('DateTime', $o['LastModifiedDate']);
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['ConnectionsId'])) $this->ConnectionsId = $o['ConnectionsId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->DbTechnologiesId)) $o['DbTechnologiesId'] = $this->DbTechnologiesId;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->CommandText)) $o['CommandText'] = $this->CommandText;
        if (isset($this->CommandTypesId)) $o['CommandTypesId'] = $this->CommandTypesId;
        if (isset($this->CacheResult)) $o['CacheResult'] = $this->CacheResult;
        if (isset($this->CachetimeInSeconds)) $o['CachetimeInSeconds'] = $this->CachetimeInSeconds;
        if (isset($this->QueryTypesId)) $o['QueryTypesId'] = $this->QueryTypesId;
        if (isset($this->DbTechnologyTemplatesId)) $o['DbTechnologyTemplatesId'] = $this->DbTechnologyTemplatesId;
        if (isset($this->LastModifiedDate)) $o['LastModifiedDate'] = JsonConverters::to('DateTime', $this->LastModifiedDate);
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->ConnectionsId)) $o['ConnectionsId'] = $this->ConnectionsId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MetaQueriesAdd 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.

POST /scadmeta/meta_queries HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MetaQueriesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <DbTechnologiesId>0</DbTechnologiesId>
  <Description>String</Description>
  <CommandText>String</CommandText>
  <CommandTypesId>0</CommandTypesId>
  <CacheResult>false</CacheResult>
  <CachetimeInSeconds>0</CachetimeInSeconds>
  <QueryTypesId>0</QueryTypesId>
  <DbTechnologyTemplatesId>0</DbTechnologyTemplatesId>
  <LastModifiedDate>0001-01-01T00:00:00</LastModifiedDate>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <IsEnabled>false</IsEnabled>
  <ConnectionsId>0</ConnectionsId>
</MetaQueriesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MetaQueriesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CacheResult>false</CacheResult>
  <CachetimeInSeconds>0</CachetimeInSeconds>
  <CommandText>String</CommandText>
  <CommandTypesId>0</CommandTypesId>
  <ConnectionsId>0</ConnectionsId>
  <DbTechnologiesId>0</DbTechnologiesId>
  <DbTechnologyTemplatesId>0</DbTechnologyTemplatesId>
  <Description>String</Description>
  <Id>0</Id>
  <IsEnabled>false</IsEnabled>
  <LastModifiedDate>0001-01-01T00:00:00</LastModifiedDate>
  <QueryTypesId>0</QueryTypesId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
</MetaQueriesAddResponse>