| Required roles: | TenantReader, TenantReader |
| GET | /api/usernotes | Returns a list of user notes, filterable by ConfigItemId | |
|---|---|---|---|
| GET | /usernotes | Returns a list of user notes, filterable by ConfigItemId |
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.Notes.Crud;
using CoreService.ServiceModel.BusinessObjects.Notes;
using CoreService.ServiceModel.BusinessObjects.Audit;
using YCO.Dune.Models.Enums;
using CoreService.ServiceModel.BusinessObjects.TimeSeries;
using CoreService.ServiceModel.BusinessObjects.Structure;
using CoreService.ServiceModel.BusinessObjects.Base;
using CoreService.ServiceModel.Enums;
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 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.Notes
{
public partial class UserNote
: Auditable, IHasId, IHasObjectType, IHasTenantId
{
public virtual Guid Id { get; set; }
[Required]
[StringLength(1000)]
public virtual string Message { get; set; }
[Required]
public virtual Guid ConfigItemId { get; set; }
[Required]
public virtual ObjectTypes ConfigItemType { get; set; }
[Required]
public virtual string ConfigItemName { get; set; }
[Required]
public virtual Guid TenantId { get; set; }
[Ignore]
public virtual ObjectTypes ObjectType { 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.Notes.Crud
{
///<summary>
///Returns a list of user notes
///</summary>
[Api(Description="Returns a list of user notes")]
[ApiResponse(Description="Ok", ResponseType=typeof(YCO.Dune.Models.Dtos.Common.Responses.ItemsResponse`1[[CoreService.ServiceModel.Dtos.Notes.Responses.UserNoteDto, CoreService.ServiceModel, Version=0.15.14.0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)]
public partial class QueryUserNotes
: QueryDb<UserNote>, IGetMultipleRequest, IHasTenantName, IGet
{
[ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
[Validate("NotEmpty")]
public virtual string TenantName { get; set; }
///<summary>
///Filter notes by the config item they are attached to
///</summary>
[ApiMember(DataType="string", Description="Filter notes by the config item they are attached to", Format="guid", ParameterType="query")]
public virtual Guid? ConfigItemId { 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; }
}
}
namespace CoreService.ServiceModel.Enums
{
public enum Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
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,
}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/usernotes 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":[{"id":"00000000-0000-0000-0000-000000000000","message":"String","configItemId":"00000000-0000-0000-0000-000000000000","configItemType":"None","configItemName":"String","tenantId":"00000000-0000-0000-0000-000000000000","objectType":"UserNote","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"}}}