Nephila RiskStore

<back to all web services

SetShouldCachePerspective

Maintenance
Requires Authentication
Requires the role:Riskstore.Admin
The following routes are available for this service:
POST/api/riskstore/maintenance/set-should-cache-perspectiveSet the ShouldCache flag on the specified perspectives only, resetting all others. This will control which event sets are cached
<?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 SetShouldCachePerspective implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The perspective ids to set the should cache flag */
        // @ApiMember(DataType="array", Description="The perspective ids to set the should cache flag", Format="int32", IsRequired=true)
        /** @var array<int>|null */
        public ?array $perspectiveIds=null,

        /** @description Set to true to force cache reload (event sets etc...) */
        // @ApiMember(DataType="boolean", Description="Set to true to force cache reload (event sets etc...)", IsRequired=true)
        /** @var bool|null */
        public ?bool $refreshCache=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['perspectiveIds'])) $this->perspectiveIds = JsonConverters::fromArray('int', $o['perspectiveIds']);
        if (isset($o['refreshCache'])) $this->refreshCache = $o['refreshCache'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->perspectiveIds)) $o['perspectiveIds'] = JsonConverters::toArray('int', $this->perspectiveIds);
        if (isset($this->refreshCache)) $o['refreshCache'] = $this->refreshCache;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SetShouldCachePerspective 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 /api/riskstore/maintenance/set-should-cache-perspective HTTP/1.1 
Host: riskstoreng-dev.nephila.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetShouldCachePerspective xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.RiskStore.ServiceModel.Requests">
  <PerspectiveIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PerspectiveIds>
  <RefreshCache>false</RefreshCache>
</SetShouldCachePerspective>