CoreService

<back to all web services

CreateCollection

Collection - CRUD

Creates a new collection

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/collections/Creates a new collection
POST/collections/Creates a new collection
<?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};


enum ObjectTypes : string
{
    case None = 'None';
    case ConfigItem = 'ConfigItem';
    case Tenant = 'Tenant';
    case Collection = 'Collection';
    case Resource = 'Resource';
    case ComputeNode = 'ComputeNode';
    case VirtualMachine = 'VirtualMachine';
    case PhysicalMachine = 'PhysicalMachine';
    case Disk = 'Disk';
    case Subnet = 'Subnet';
    case IPAddress = 'IPAddress';
    case Job = 'Job';
    case JobEvent = 'JobEvent';
    case FreezePeriod = 'FreezePeriod';
    case ResourceGroup = 'ResourceGroup';
    case Deployment = 'Deployment';
    case ResourceGroupTemplate = 'ResourceGroupTemplate';
    case DeploymentTemplate = 'DeploymentTemplate';
    case ResourceProvider = 'ResourceProvider';
    case GenericResource = 'GenericResource';
    case Role = 'Role';
    case Permission = 'Permission';
    case User = 'User';
    case PatchingWindow = 'PatchingWindow';
    case Update = 'Update';
    case ReportDefinition = 'ReportDefinition';
    case TimeSeries = 'TimeSeries';
    case DataPoint = 'DataPoint';
    case Action = 'Action';
    case ActionAssignment = 'ActionAssignment';
    case UserNote = 'UserNote';
}

class TagDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $name='',
        /** @var string|null */
        public ?string $value=null,
        /** @var bool|null */
        public ?bool $isProtected=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['value'])) $this->value = $o['value'];
        if (isset($o['isProtected'])) $this->isProtected = $o['isProtected'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->value)) $o['value'] = $this->value;
        if (isset($this->isProtected)) $o['isProtected'] = $this->isProtected;
        return empty($o) ? new class(){} : $o;
    }
}

class PathItemDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $label='',
        /** @var string */
        public string $link='',
        /** @var ObjectTypes|null */
        public ?ObjectTypes $objectType=null,
        /** @var string */
        public string $objectId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['label'])) $this->label = $o['label'];
        if (isset($o['link'])) $this->link = $o['link'];
        if (isset($o['objectType'])) $this->objectType = JsonConverters::from('ObjectTypes', $o['objectType']);
        if (isset($o['objectId'])) $this->objectId = $o['objectId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->label)) $o['label'] = $this->label;
        if (isset($this->link)) $o['link'] = $this->link;
        if (isset($this->objectType)) $o['objectType'] = JsonConverters::to('ObjectTypes', $this->objectType);
        if (isset($this->objectId)) $o['objectId'] = $this->objectId;
        return empty($o) ? new class(){} : $o;
    }
}

class LinkDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $caption='',
        /** @var string */
        public string $rel='',
        /** @var string */
        public string $hRef='',
        /** @var string */
        public string $method=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['caption'])) $this->caption = $o['caption'];
        if (isset($o['rel'])) $this->rel = $o['rel'];
        if (isset($o['hRef'])) $this->hRef = $o['hRef'];
        if (isset($o['method'])) $this->method = $o['method'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->caption)) $o['caption'] = $this->caption;
        if (isset($this->rel)) $o['rel'] = $this->rel;
        if (isset($this->hRef)) $o['hRef'] = $this->hRef;
        if (isset($this->method)) $o['method'] = $this->method;
        return empty($o) ? new class(){} : $o;
    }
}

class ConfigItemDto implements IConfigItem, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $id='',
        /** @var string */
        public string $name='',
        /** @var string */
        public string $displayName='',
        /** @var string|null */
        public ?string $description=null,
        /** @var ObjectTypes|null */
        public ?ObjectTypes $objectType=null,
        /** @var string */
        public string $selfLink='',
        /** @var array<TagDto>|null */
        public ?array $tags=null,
        /** @var array<PathItemDto>|null */
        public ?array $path=null,
        /** @var DateTime */
        public DateTime $created=new DateTime(),
        /** @var string */
        public string $createUser='',
        /** @var string */
        public string $createUserId='',
        /** @var DateTime */
        public DateTime $modified=new DateTime(),
        /** @var string */
        public string $modifyUser='',
        /** @var string */
        public string $modifyUserId='',
        /** @var bool|null */
        public ?bool $isDeleted=null,
        /** @var DateTime|null */
        public ?DateTime $deleted=null,
        /** @var string|null */
        public ?string $deleteUser=null,
        /** @var string|null */
        public ?string $deleteUserId=null,
        /** @var array<LinkDto>|null */
        public ?array $links=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['objectType'])) $this->objectType = JsonConverters::from('ObjectTypes', $o['objectType']);
        if (isset($o['selfLink'])) $this->selfLink = $o['selfLink'];
        if (isset($o['tags'])) $this->tags = JsonConverters::fromArray('TagDto', $o['tags']);
        if (isset($o['path'])) $this->path = JsonConverters::fromArray('PathItemDto', $o['path']);
        if (isset($o['created'])) $this->created = JsonConverters::from('DateTime', $o['created']);
        if (isset($o['createUser'])) $this->createUser = $o['createUser'];
        if (isset($o['createUserId'])) $this->createUserId = $o['createUserId'];
        if (isset($o['modified'])) $this->modified = JsonConverters::from('DateTime', $o['modified']);
        if (isset($o['modifyUser'])) $this->modifyUser = $o['modifyUser'];
        if (isset($o['modifyUserId'])) $this->modifyUserId = $o['modifyUserId'];
        if (isset($o['isDeleted'])) $this->isDeleted = $o['isDeleted'];
        if (isset($o['deleted'])) $this->deleted = JsonConverters::from('DateTime', $o['deleted']);
        if (isset($o['deleteUser'])) $this->deleteUser = $o['deleteUser'];
        if (isset($o['deleteUserId'])) $this->deleteUserId = $o['deleteUserId'];
        if (isset($o['links'])) $this->links = JsonConverters::fromArray('LinkDto', $o['links']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->objectType)) $o['objectType'] = JsonConverters::to('ObjectTypes', $this->objectType);
        if (isset($this->selfLink)) $o['selfLink'] = $this->selfLink;
        if (isset($this->tags)) $o['tags'] = JsonConverters::toArray('TagDto', $this->tags);
        if (isset($this->path)) $o['path'] = JsonConverters::toArray('PathItemDto', $this->path);
        if (isset($this->created)) $o['created'] = JsonConverters::to('DateTime', $this->created);
        if (isset($this->createUser)) $o['createUser'] = $this->createUser;
        if (isset($this->createUserId)) $o['createUserId'] = $this->createUserId;
        if (isset($this->modified)) $o['modified'] = JsonConverters::to('DateTime', $this->modified);
        if (isset($this->modifyUser)) $o['modifyUser'] = $this->modifyUser;
        if (isset($this->modifyUserId)) $o['modifyUserId'] = $this->modifyUserId;
        if (isset($this->isDeleted)) $o['isDeleted'] = $this->isDeleted;
        if (isset($this->deleted)) $o['deleted'] = JsonConverters::to('DateTime', $this->deleted);
        if (isset($this->deleteUser)) $o['deleteUser'] = $this->deleteUser;
        if (isset($this->deleteUserId)) $o['deleteUserId'] = $this->deleteUserId;
        if (isset($this->links)) $o['links'] = JsonConverters::toArray('LinkDto', $this->links);
        return empty($o) ? new class(){} : $o;
    }
}

enum ValueDataType : string
{
    case String = 'String';
    case Number = 'Number';
    case Boolean = 'Boolean';
    case List = 'List';
}

enum Environments : string
{
    case Lab = 'Lab';
    case Poc = 'Poc';
    case Dev = 'Dev';
    case Test = 'Test';
    case Int = 'Int';
    case Uat = 'Uat';
    case Prod = 'Prod';
}

class VariableDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $name='',
        /** @description Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes */
        /** @var string */
        public string $value='',
        /** @description The data type of the value property */
        /** @var ValueDataType|null */
        public ?ValueDataType $type=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var bool|null */
        public ?bool $isInherited=null,
        /** @var Environments|null */
        public ?Environments $environment=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['value'])) $this->value = $o['value'];
        if (isset($o['type'])) $this->type = JsonConverters::from('ValueDataType', $o['type']);
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['isInherited'])) $this->isInherited = $o['isInherited'];
        if (isset($o['environment'])) $this->environment = JsonConverters::from('Environments', $o['environment']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->value)) $o['value'] = $this->value;
        if (isset($this->type)) $o['type'] = JsonConverters::to('ValueDataType', $this->type);
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->isInherited)) $o['isInherited'] = $this->isInherited;
        if (isset($this->environment)) $o['environment'] = JsonConverters::to('Environments', $this->environment);
        return empty($o) ? new class(){} : $o;
    }
}

class TenantDto extends ConfigItemDto implements JsonSerializable
{
    /**
     * @param string $id
     * @param string $name
     * @param string $displayName
     * @param string|null $description
     * @param ObjectTypes|null $objectType
     * @param string $selfLink
     * @param array<TagDto>|null $tags
     * @param array<PathItemDto>|null $path
     * @param DateTime $created
     * @param string $createUser
     * @param string $createUserId
     * @param DateTime $modified
     * @param string $modifyUser
     * @param string $modifyUserId
     * @param bool|null $isDeleted
     * @param DateTime|null $deleted
     * @param string|null $deleteUser
     * @param string|null $deleteUserId
     * @param array<LinkDto>|null $links
     */
    public function __construct(
        string $id='',
        string $name='',
        string $displayName='',
        ?string $description=null,
        ?ObjectTypes $objectType=null,
        string $selfLink='',
        ?array $tags=null,
        ?array $path=null,
        DateTime $created=new DateTime(),
        string $createUser='',
        string $createUserId='',
        DateTime $modified=new DateTime(),
        string $modifyUser='',
        string $modifyUserId='',
        ?bool $isDeleted=null,
        ?DateTime $deleted=null,
        ?string $deleteUser=null,
        ?string $deleteUserId=null,
        ?array $links=null,
        /** @description Variables defined on tenant level */
        /** @var array<VariableDto>|null */
        public ?array $variables=null,
        /** @description Allowed email domains used for authentication */
        /** @var array<string>|null */
        public ?array $allowedMailDomains=null,
        /** @description List of licensed modules for this tenant */
        /** @var array<string>|null */
        public ?array $licensedModules=null,
        /** @description Amount of days until a Deployment expires */
        /** @var int */
        public int $defaultDeploymentLifetimeDays=0,
        /** @description Max amount of days until a Deployment expires */
        /** @var int */
        public int $maxDeploymentLifetimeDays=0,
        /** @description Amount of days without patching until a unpatched warning is shown */
        /** @var int */
        public int $systemUnpatchedWarningDays=0,
        /** @description Amount of hours without backup until a backup missing warning is shown */
        /** @var int */
        public int $systemBackupMissingWarningHours=0,
        /** @description Amount of days until a vulnerable resource is getting stopped */
        /** @var int */
        public int $stopVulnerableResourceAfterDays=0,
        /** @description Amount of days before deployment expiration, which triggers the expiration warning */
        /** @var int */
        public int $deploymentExpirationWarningDays=0,
        /** @description Amount of days the patch notification is sent out prior to the patch date */
        /** @var int */
        public int $patchNotificationDays=0,
        /** @description Use a pool with your own hostnames (true) or let the hostname be auto generated (false) */
        /** @var bool|null */
        public ?bool $useCustomHostnames=null,
        /** @description After how many days inactive vulnerabilities will be purged from database */
        /** @var int */
        public int $removeInactiveVulnerabilitiesAfterDays=0
    ) {
        parent::__construct($id,$name,$displayName,$description,$objectType,$selfLink,$tags,$path,$created,$createUser,$createUserId,$modified,$modifyUser,$modifyUserId,$isDeleted,$deleted,$deleteUser,$deleteUserId,$links);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['variables'])) $this->variables = JsonConverters::fromArray('VariableDto', $o['variables']);
        if (isset($o['allowedMailDomains'])) $this->allowedMailDomains = JsonConverters::fromArray('string', $o['allowedMailDomains']);
        if (isset($o['licensedModules'])) $this->licensedModules = JsonConverters::fromArray('string', $o['licensedModules']);
        if (isset($o['defaultDeploymentLifetimeDays'])) $this->defaultDeploymentLifetimeDays = $o['defaultDeploymentLifetimeDays'];
        if (isset($o['maxDeploymentLifetimeDays'])) $this->maxDeploymentLifetimeDays = $o['maxDeploymentLifetimeDays'];
        if (isset($o['systemUnpatchedWarningDays'])) $this->systemUnpatchedWarningDays = $o['systemUnpatchedWarningDays'];
        if (isset($o['systemBackupMissingWarningHours'])) $this->systemBackupMissingWarningHours = $o['systemBackupMissingWarningHours'];
        if (isset($o['stopVulnerableResourceAfterDays'])) $this->stopVulnerableResourceAfterDays = $o['stopVulnerableResourceAfterDays'];
        if (isset($o['deploymentExpirationWarningDays'])) $this->deploymentExpirationWarningDays = $o['deploymentExpirationWarningDays'];
        if (isset($o['patchNotificationDays'])) $this->patchNotificationDays = $o['patchNotificationDays'];
        if (isset($o['useCustomHostnames'])) $this->useCustomHostnames = $o['useCustomHostnames'];
        if (isset($o['removeInactiveVulnerabilitiesAfterDays'])) $this->removeInactiveVulnerabilitiesAfterDays = $o['removeInactiveVulnerabilitiesAfterDays'];
        if (isset($o['links'])) $this->links = JsonConverters::fromArray('LinkDto', $o['links']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->variables)) $o['variables'] = JsonConverters::toArray('VariableDto', $this->variables);
        if (isset($this->allowedMailDomains)) $o['allowedMailDomains'] = JsonConverters::toArray('string', $this->allowedMailDomains);
        if (isset($this->licensedModules)) $o['licensedModules'] = JsonConverters::toArray('string', $this->licensedModules);
        if (isset($this->defaultDeploymentLifetimeDays)) $o['defaultDeploymentLifetimeDays'] = $this->defaultDeploymentLifetimeDays;
        if (isset($this->maxDeploymentLifetimeDays)) $o['maxDeploymentLifetimeDays'] = $this->maxDeploymentLifetimeDays;
        if (isset($this->systemUnpatchedWarningDays)) $o['systemUnpatchedWarningDays'] = $this->systemUnpatchedWarningDays;
        if (isset($this->systemBackupMissingWarningHours)) $o['systemBackupMissingWarningHours'] = $this->systemBackupMissingWarningHours;
        if (isset($this->stopVulnerableResourceAfterDays)) $o['stopVulnerableResourceAfterDays'] = $this->stopVulnerableResourceAfterDays;
        if (isset($this->deploymentExpirationWarningDays)) $o['deploymentExpirationWarningDays'] = $this->deploymentExpirationWarningDays;
        if (isset($this->patchNotificationDays)) $o['patchNotificationDays'] = $this->patchNotificationDays;
        if (isset($this->useCustomHostnames)) $o['useCustomHostnames'] = $this->useCustomHostnames;
        if (isset($this->removeInactiveVulnerabilitiesAfterDays)) $o['removeInactiveVulnerabilitiesAfterDays'] = $this->removeInactiveVulnerabilitiesAfterDays;
        if (isset($this->links)) $o['links'] = JsonConverters::toArray('LinkDto', $this->links);
        return empty($o) ? new class(){} : $o;
    }
}

class DeploymentCollectionDto extends ConfigItemDto implements IHasTenantId, JsonSerializable
{
    /**
     * @param string $id
     * @param string $name
     * @param string $displayName
     * @param string|null $description
     * @param ObjectTypes|null $objectType
     * @param string $selfLink
     * @param array<TagDto>|null $tags
     * @param array<PathItemDto>|null $path
     * @param DateTime $created
     * @param string $createUser
     * @param string $createUserId
     * @param DateTime $modified
     * @param string $modifyUser
     * @param string $modifyUserId
     * @param bool|null $isDeleted
     * @param DateTime|null $deleted
     * @param string|null $deleteUser
     * @param string|null $deleteUserId
     * @param array<LinkDto>|null $links
     */
    public function __construct(
        string $id='',
        string $name='',
        string $displayName='',
        ?string $description=null,
        ?ObjectTypes $objectType=null,
        string $selfLink='',
        ?array $tags=null,
        ?array $path=null,
        DateTime $created=new DateTime(),
        string $createUser='',
        string $createUserId='',
        DateTime $modified=new DateTime(),
        string $modifyUser='',
        string $modifyUserId='',
        ?bool $isDeleted=null,
        ?DateTime $deleted=null,
        ?string $deleteUser=null,
        ?string $deleteUserId=null,
        ?array $links=null,
        /** @var string */
        public string $tenantId='',
        /** @var TenantDto|null */
        public ?TenantDto $tenant=null,
        /** @description A collection scoped list of variables */
        /** @var array<VariableDto>|null */
        public ?array $variables=null,
        /** @description Defines the collection where scanned but not deployed resources will be stored */
        /** @var bool|null */
        public ?bool $isLostAndFound=null,
        /** @description The monthly cost budget for the whole collection */
        /** @var float|null */
        public ?float $monthlyBudget=null,
        /** @description Whether to send budget information mails to the collection owners */
        /** @var bool|null */
        public ?bool $sendBudgetNotificationMails=null,
        /** @description A threshold, when to send the first budget warning mail */
        /** @var int|null */
        public ?int $budgetWarningThresholdPercent=null
    ) {
        parent::__construct($id,$name,$displayName,$description,$objectType,$selfLink,$tags,$path,$created,$createUser,$createUserId,$modified,$modifyUser,$modifyUserId,$isDeleted,$deleted,$deleteUser,$deleteUserId,$links);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['tenantId'])) $this->tenantId = $o['tenantId'];
        if (isset($o['tenant'])) $this->tenant = JsonConverters::from('TenantDto', $o['tenant']);
        if (isset($o['variables'])) $this->variables = JsonConverters::fromArray('VariableDto', $o['variables']);
        if (isset($o['isLostAndFound'])) $this->isLostAndFound = $o['isLostAndFound'];
        if (isset($o['monthlyBudget'])) $this->monthlyBudget = $o['monthlyBudget'];
        if (isset($o['sendBudgetNotificationMails'])) $this->sendBudgetNotificationMails = $o['sendBudgetNotificationMails'];
        if (isset($o['budgetWarningThresholdPercent'])) $this->budgetWarningThresholdPercent = $o['budgetWarningThresholdPercent'];
        if (isset($o['links'])) $this->links = JsonConverters::fromArray('LinkDto', $o['links']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->tenantId)) $o['tenantId'] = $this->tenantId;
        if (isset($this->tenant)) $o['tenant'] = JsonConverters::to('TenantDto', $this->tenant);
        if (isset($this->variables)) $o['variables'] = JsonConverters::toArray('VariableDto', $this->variables);
        if (isset($this->isLostAndFound)) $o['isLostAndFound'] = $this->isLostAndFound;
        if (isset($this->monthlyBudget)) $o['monthlyBudget'] = $this->monthlyBudget;
        if (isset($this->sendBudgetNotificationMails)) $o['sendBudgetNotificationMails'] = $this->sendBudgetNotificationMails;
        if (isset($this->budgetWarningThresholdPercent)) $o['budgetWarningThresholdPercent'] = $this->budgetWarningThresholdPercent;
        if (isset($this->links)) $o['links'] = JsonConverters::toArray('LinkDto', $this->links);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Creates a new collection */
// @Api(Description="Creates a new collection")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType="typeof(CoreService.ServiceModel.Dtos.Collections.Responses.DeploymentCollectionDto)", StatusCode=201)
class CreateCollection implements ICreateRequest, IHasTenantName, IPost, JsonSerializable
{
    public function __construct(
        // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        // @Validate(Validator="NotEmpty")
        /** @var string */
        public string $tenantName='',

        /** @description The collections name */
        // @ApiMember(DataType="string", Description="The collections name", IsRequired=true, ParameterType="body")
        // @Validate(Validator="NotEmpty")
        // @Validate(Validator="MaximumLength(50)")
        // @Validate(Validator="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")
        /** @var string */
        public string $name='',

        /** @description The collections display name */
        // @ApiMember(DataType="string", Description="The collections display name", ParameterType="body")
        // @Validate(Validator="MaximumLength(250)")
        /** @var string|null */
        public ?string $displayName=null,

        /** @description A more detailed description for the collection */
        // @ApiMember(DataType="string", Description="A more detailed description for the collection", ParameterType="body")
        // @Validate(Validator="MaximumLength(8000)")
        /** @var string|null */
        public ?string $description=null,

        /** @description Defines the collections where scanned but not deployed resources will be stored */
        // @ApiMember(DataType="bool", Description="Defines the collections where scanned but not deployed resources will be stored")
        /** @var bool|null */
        public ?bool $isLostAndFound=null,

        // @ApiMember(DataType="array", ParameterType="body")
        /** @var array<VariableDto>|null */
        public ?array $variables=null,

        // @ApiMember(DataType="array", ParameterType="body")
        /** @var array<TagDto>|null */
        public ?array $tags=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantName'])) $this->tenantName = $o['tenantName'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['isLostAndFound'])) $this->isLostAndFound = $o['isLostAndFound'];
        if (isset($o['variables'])) $this->variables = JsonConverters::fromArray('VariableDto', $o['variables']);
        if (isset($o['tags'])) $this->tags = JsonConverters::fromArray('TagDto', $o['tags']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantName)) $o['tenantName'] = $this->tenantName;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->isLostAndFound)) $o['isLostAndFound'] = $this->isLostAndFound;
        if (isset($this->variables)) $o['variables'] = JsonConverters::toArray('VariableDto', $this->variables);
        if (isset($this->tags)) $o['tags'] = JsonConverters::toArray('TagDto', $this->tags);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateCollection DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/collections/ HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","name":"String","displayName":"String","description":"String","isLostAndFound":false,"variables":null,"tags":null,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"tenantId":"00000000-0000-0000-0000-000000000000","tenant":{"variables":null,"allowedMailDomains":null,"licensedModules":null,"defaultDeploymentLifetimeDays":0,"maxDeploymentLifetimeDays":0,"systemUnpatchedWarningDays":0,"systemBackupMissingWarningHours":0,"stopVulnerableResourceAfterDays":0,"deploymentExpirationWarningDays":0,"patchNotificationDays":0,"useCustomHostnames":false,"removeInactiveVulnerabilitiesAfterDays":0,"links":[{"caption":"Collections","rel":"down","hRef":"/collections/","method":"GET"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"},"variables":null,"isLostAndFound":false,"monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"up","hRef":"/collections/","method":"GET"},{"caption":"Deployments","rel":"down","hRef":"/deployments?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"}