CoreService

<back to all web services

QueryActions

Action - CRUD

Returns a list of actions

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/actions/Returns a list of actions
GET/actions/Returns a list of actions
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CoreService.ServiceModel.Dtos.Actions.Crud;
using CoreService.ServiceModel.BusinessObjects.Actions;
using CoreService.ServiceModel.BusinessObjects.Base;
using CoreService.ServiceModel.BusinessObjects.Audit;
using YCO.Dune.Models.Enums;
using CoreService.ServiceModel.Enums;
using CoreService.ServiceModel.BusinessObjects.TimeSeries;
using CoreService.ServiceModel.BusinessObjects.Structure;

namespace CoreService.ServiceModel.BusinessObjects.Actions
{
    public partial class Action
        : ConfigItem, IHasTenantId
    {
        public virtual Guid TenantId { get; set; }
        public virtual int SchemaVersion { get; set; }
        public virtual string DefinitionJson { get; set; }
        public virtual string DefinitionYaml { get; set; }
        public virtual IList<Parameter> Parameters { get; set; }
        public virtual bool IsDisabled { get; set; }
        public virtual ObjectTypes ObjectType { get; set; }
        public virtual ActionScopes Scope { get; set; }
        [Ignore]
        public virtual string SelfLink { get; set; }

        public virtual List<ActionStep> Steps { get; set; } = [];
    }

    public partial class ActionStep
    {
        public virtual string Name { get; set; }
        public virtual string? DisplayName { get; set; }
        public virtual Dictionary<string, Object> Variables { get; set; } = new();
        public virtual string? Credential { get; set; }
        public virtual string? Limit { get; set; }
        public virtual string? Type { get; set; }
        public virtual string? Module { get; set; }
        public virtual string? ExecutionEnvironment { get; set; }
        public virtual string? Inventory { get; set; }
    }

}

namespace CoreService.ServiceModel.BusinessObjects.Audit
{
    public partial class Auditable
        : IAuditable
    {
        [Required]
        public virtual DateTime Created { get; set; }

        [Required]
        public virtual string CreateUser { get; set; }

        [Required]
        public virtual string CreateUserId { get; set; }

        [Required]
        public virtual DateTime Modified { get; set; }

        [Required]
        public virtual string ModifyUser { get; set; }

        [Required]
        public virtual string ModifyUserId { get; set; }

        [Required]
        public virtual bool IsDeleted { get; set; }

        public virtual DateTime? Deleted { get; set; }
        public virtual string? DeleteUser { get; set; }
        public virtual string? DeleteUserId { get; set; }
    }

}

namespace CoreService.ServiceModel.BusinessObjects.Base
{
    public partial class ConfigItem
        : Auditable, IConfigItem
    {
        public virtual Guid Id { get; set; }
        [Required]
        public virtual string Name { get; set; }

        [Required]
        [StringLength(250)]
        public virtual string DisplayName { get; set; }

        [StringLength(8000)]
        public virtual string? Description { get; set; }

        public virtual ObjectTypes ObjectType { get; set; }
        [Ignore]
        public virtual string SelfLink { get; set; }

        [Required]
        public virtual IList<Tag> Tags { get; set; }

        [Required]
        public virtual IList<PathItem> Path { get; set; }
    }

    public partial class Parameter
    {
        public virtual string Name { get; set; }
        public virtual string? Description { get; set; }
        public virtual string? Value { get; set; }
        public virtual string? Default { get; set; }
        public virtual bool Optional { get; set; }
        public virtual ParameterValueType Type { get; set; }
        public virtual string? Validation { get; set; }
    }

    public partial class PathItem
    {
        public virtual string Label { get; set; }
        public virtual string Link { get; set; }
        public virtual ObjectTypes ObjectType { get; set; }
        public virtual Guid ObjectId { get; set; }
    }

    public partial class Tag
    {
        public virtual string Name { get; set; }
        public virtual string? Value { get; set; }
        public virtual bool IsProtected { get; set; }
    }

    public partial class Variable
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
        public virtual ValueDataType Type { get; set; }
        public virtual string? Description { get; set; }
        public virtual bool IsInherited { get; set; }
        public virtual Environments? Environment { get; set; }
    }

}

namespace CoreService.ServiceModel.BusinessObjects.Structure
{
    public partial class Tenant
        : ConfigItem, IHasVariables
    {
        [Required]
        [StringLength(10)]
        public virtual string Name { get; set; }

        [Required]
        public virtual ObjectTypes ObjectType { get; set; }

        [Ignore]
        public virtual string SelfLink { get; set; }

        [Required]
        public virtual IList<Variable> Variables { get; set; }

        [Required]
        public virtual IList<string> AllowedMailDomains { get; set; }

        [Required]
        public virtual IList<string> LicensedModules { get; set; }

        [Required]
        public virtual short DefaultDeploymentLifetimeDays { get; set; }

        [Required]
        public virtual short MaxDeploymentLifetimeDays { get; set; }

        [Required]
        public virtual short SystemUnpatchedWarningDays { get; set; }

        [Required]
        public virtual short SystemBackupMissingWarningHours { get; set; }

        [Required]
        public virtual short StopVulnerableResourceAfterDays { get; set; }

        [Required]
        public virtual short DeploymentExpirationWarningDays { get; set; }

        [Required]
        public virtual short PatchNotificationDays { get; set; }

        [Required]
        public virtual bool UseCustomHostnames { get; set; }

        [Required]
        public virtual short RemoveInactiveVulnerabilitiesAfterDays { get; set; }
    }

}

namespace CoreService.ServiceModel.BusinessObjects.TimeSeries
{
    public partial class TimeSeriesDefinition
        : Auditable, IHasIdName, IHasTenantId, IHasObjectType
    {
        public virtual Guid Id { get; set; }
        [References(typeof(CoreService.ServiceModel.BusinessObjects.Structure.Tenant))]
        public virtual Guid TenantId { get; set; }

        public virtual Tenant? Tenant { get; set; }
        public virtual string Name { get; set; }
        public virtual string? DisplayName { get; set; }
        [Ignore]
        public virtual string SelfLink { get; set; }

        [Required]
        public virtual ObjectTypes ObjectType { get; set; }

        public virtual string? Description { get; set; }
        public virtual ObjectTypes SourceType { get; set; }
        public virtual bool AutoCollection { get; set; }
        public virtual string? AutoCollectionQuery { get; set; }
        public virtual int? AutoCollectionInterval { get; set; }
        public virtual IntervalUnits? AutoCollectionIntervalUnit { get; set; }
        public virtual TimeOnly? AutoCollectionTime { get; set; }
        public virtual DateTime? LastAutoCollected { get; set; }
        public virtual int RetentionTimeMonths { get; set; }
    }

}

namespace CoreService.ServiceModel.Dtos.Actions.Crud
{
    ///<summary>
    ///Returns a list of actions
    ///</summary>
    [Api(Description="Returns a list of actions")]
    [ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(YCO.Dune.Models.Dtos.Common.Responses.ItemsResponse`1[[CoreService.ServiceModel.Dtos.Actions.Responses.ActionDto, CoreService.ServiceModel, Version=0.15.14.0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)]
    public partial class QueryActions
        : QueryDb<Action>, IGetMultipleRequest, IHasTenantName, IGet, IGroupable
    {
        [ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
        [Validate("NotEmpty")]
        public virtual string TenantName { get; set; }

        ///<summary>
        ///If true, also soft deleted items will be returned
        ///</summary>
        [ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")]
        public virtual bool? IncludeDeleted { get; set; }

        ///<summary>
        ///The property, the data will be grouped on
        ///</summary>
        [ApiMember(Description="The property, the data will be grouped on", ParameterType="query")]
        public virtual string? GroupBy { get; set; }

        ///<summary>
        ///The property, used for aggregation
        ///</summary>
        [ApiMember(Description="The property, used for aggregation", ParameterType="query")]
        public virtual string? AggregateOn { get; set; }

        ///<summary>
        ///The aggregation function to use
        ///</summary>
        [ApiMember(Description="The aggregation function to use", ParameterType="query")]
        public virtual Aggregations? Aggregation { get; set; }

        ///<summary>
        ///If true, also include the json definition
        ///</summary>
        [ApiMember(Description="If true, also include the json definition", ParameterType="query")]
        public virtual bool? IncludeDefinition { get; set; }

        ///<summary>
        ///Returns all referenced object
        ///</summary>
        [ApiMember(Description="Returns all referenced object", ParameterType="query")]
        public virtual bool? IncludeReferencedObjects { get; set; }
    }

}

namespace CoreService.ServiceModel.Enums
{
    public enum ActionScopes
    {
        Deployment,
        ResourceGroup,
        Resource,
    }

    public enum Aggregations
    {
        None,
        Count,
        DistinctCount,
        Sum,
        Min,
        Max,
        Avg,
        First,
    }

    public enum Environments
    {
        Lab,
        Poc,
        Dev,
        Test,
        Int,
        Uat,
        Prod,
    }

    public enum ParameterValueType
    {
        String,
        Number,
        Boolean,
        SecureString,
    }

    public enum ValueDataType
    {
        String,
        Number,
        Boolean,
        List,
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<T>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<TimeSeriesDefinition> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

namespace YCO.Dune.Models.Enums
{
    public enum IntervalUnits
    {
        Second,
        Minute,
        Hour,
        Day,
        Week,
        Month,
        Year,
    }

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

}

C# QueryActions 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.

GET /api/actions/ HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"tenantId":"00000000-0000-0000-0000-000000000000","schemaVersion":0,"definitionJson":"String","definitionYaml":"String","parameters":null,"isDisabled":false,"objectType":"Action","scope":"Deployment","selfLink":"/actions/00000000-0000-0000-0000-000000000000","steps":[{"name":"String","displayName":"String","variables":{"String":{}},"credential":"String","limit":"String","type":"String","module":"String","executionEnvironment":"String","inventory":"String"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"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"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}