| 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 |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Returns a list of user notes
*/
@Api(Description="Returns a list of user notes")
@ApiResponse(Description="Ok", ResponseType=0, Culture=neutral, PublicKeyToken=null]]::class, StatusCode=200)
open class QueryUserNotes : QueryDb<UserNote>(), IGetMultipleRequest, IHasTenantName, IGet
{
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
override var tenantName:String? = null
/**
* Filter notes by the config item they are attached to
*/
@ApiMember(DataType="string", Description="Filter notes by the config item they are attached to", Format="guid", ParameterType="query")
open var configItemId:UUID? = null
/**
* If true, also soft deleted items will be returned
*/
@ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
override var includeDeleted:Boolean? = null
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
open var skip:Int? = null
@DataMember(Order=2)
open var take:Int? = null
@DataMember(Order=3)
open var orderBy:String? = null
@DataMember(Order=4)
open var orderByDesc:String? = null
@DataMember(Order=5)
open var include:String? = null
@DataMember(Order=6)
open var fields:String? = null
@DataMember(Order=7)
open var meta:HashMap<String,String>? = null
}
open class UserNote : Auditable(), IHasId, IHasObjectType, IHasTenantId
{
override var id:UUID? = null
@Required()
@StringLength(MaximumLength=1000)
open var message:String? = null
@Required()
open var configItemId:UUID? = null
@Required()
open var configItemType:ObjectTypes? = null
@Required()
open var configItemName:String? = null
@Required()
override var tenantId:UUID? = null
@Ignore()
override var objectType:ObjectTypes? = null
}
open class Auditable : IAuditable
{
@Required()
override var created:Date? = null
@Required()
override var createUser:String? = null
@Required()
override var createUserId:String? = null
@Required()
override var modified:Date? = null
@Required()
override var modifyUser:String? = null
@Required()
override var modifyUserId:String? = null
@Required()
override var isDeleted:Boolean? = null
override var deleted:Date? = null
override var deleteUser:String? = null
override var deleteUserId:String? = null
}
enum class 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,
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var offset:Int? = null
@DataMember(Order=2)
open var total:Int? = null
@DataMember(Order=3)
open var results:ArrayList<TimeSeriesDefinition> = ArrayList<TimeSeriesDefinition>()
@DataMember(Order=4)
open var meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var responseStatus:ResponseStatus? = null
}
open class TimeSeriesDefinition : Auditable(), IHasIdName, IHasTenantId, IHasObjectType
{
open var id:UUID? = null
@References(Type=Tenant::class)
override var tenantId:UUID? = null
open var tenant:Tenant? = null
override var name:String? = null
open var displayName:String? = null
@Ignore()
open var selfLink:String? = null
@Required()
override var objectType:ObjectTypes? = null
open var description:String? = null
open var sourceType:ObjectTypes? = null
open var autoCollection:Boolean? = null
open var autoCollectionQuery:String? = null
open var autoCollectionInterval:Int? = null
open var autoCollectionIntervalUnit:IntervalUnits? = null
open var autoCollectionTime:TimeSpan? = null
open var lastAutoCollected:Date? = null
open var retentionTimeMonths:Int? = null
}
open class Tenant : ConfigItem(), IHasVariables
{
@Required()
@StringLength(MaximumLength=10)
override var name:String? = null
@Required()
override var objectType:ObjectTypes? = null
@Ignore()
override var selfLink:String? = null
@Required()
override var variables:IList<Variable>? = null
@Required()
open var allowedMailDomains:IList<String>? = null
@Required()
open var licensedModules:IList<String>? = null
@Required()
open var defaultDeploymentLifetimeDays:Short? = null
@Required()
open var maxDeploymentLifetimeDays:Short? = null
@Required()
open var systemUnpatchedWarningDays:Short? = null
@Required()
open var systemBackupMissingWarningHours:Short? = null
@Required()
open var stopVulnerableResourceAfterDays:Short? = null
@Required()
open var deploymentExpirationWarningDays:Short? = null
@Required()
open var patchNotificationDays:Short? = null
@Required()
open var useCustomHostnames:Boolean? = null
@Required()
open var removeInactiveVulnerabilitiesAfterDays:Short? = null
}
open class ConfigItem : Auditable(), IConfigItem
{
open var id:UUID? = null
@Required()
open var name:String? = null
@Required()
@StringLength(MaximumLength=250)
override var displayName:String? = null
@StringLength(MaximumLength=8000)
override var description:String? = null
open var objectType:ObjectTypes? = null
@Ignore()
override var selfLink:String? = null
@Required()
override var tags:IList<Tag>? = null
@Required()
override var path:IList<PathItem>? = null
}
open class Tag
{
open var name:String? = null
open var value:String? = null
open var isProtected:Boolean? = null
}
open class PathItem
{
open var label:String? = null
open var link:String? = null
open var objectType:ObjectTypes? = null
open var objectId:UUID? = null
}
open class Variable
{
open var name:String? = null
open var value:String? = null
@SerializedName("type") open var Type:ValueDataType? = null
open var description:String? = null
open var isInherited:Boolean? = null
open var environment:Environments? = null
}
enum class ValueDataType
{
String,
Number,
Boolean,
List,
}
enum class Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
enum class IntervalUnits
{
Second,
Minute,
Hour,
Day,
Week,
Month,
Year,
}
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"}}}