| Required role: | TenantReader |
| GET | /api/resources/{Id}/variables | Gets the resource's variables | |
|---|---|---|---|
| GET | /resources/{Id}/variables | Gets the resource's variables |
import Foundation
import ServiceStack
/**
* Gets the resource's variables
*/
// @Api(Description="Gets the resource's variables")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)
public class GetResourceVariables : IBaseRequest, IHasId, IHasTenantName, IGet, Codable
{
// @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
public var id:String
// @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
// @Validate(Validator="NotEmpty")
public var tenantName:String
/**
* Include inherited variables
*/
// @ApiMember(Description="Include inherited variables", ParameterType="query")
public var includeInherited:Bool?
required public init(){}
}
public class ItemsResponse<T : Codable> : Codable
{
public var items:IList<VariableDto>
public var offset:Int
public var total:Int
public var isGrouped:Bool
public var responseStatus:ResponseStatus
public var meta:[String:String]
required public init(){}
}
public class VariableDto : Codable
{
public var name:String
/**
* 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
*/
public var value:String
/**
* The data type of the value property
*/
public var type:ValueDataType
public var Description:String
public var isInherited:Bool
public var environment:Environments?
required public init(){}
}
public enum ValueDataType : String, Codable
{
case String
case Number
case Boolean
case List
}
public enum Environments : String, Codable
{
case Lab
case Poc
case Dev
case Test
case Int
case Uat
case Prod
}
Swift GetResourceVariables 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/resources/{Id}/variables HTTP/1.1
Host: core.starburst.svc
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}