CoreService

<back to all web services

GetCollectionVariables

Collection - CRUD

Gets the collection's variables

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/collections/{Id}/variablesGets the collection's variables
GET/collections/{Id}/variablesGets the collection's variables
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Gets the collection's variables
*/
@Api(Description="Gets the collection's variables")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=0, Culture=neutral, PublicKeyToken=null]]::class, StatusCode=200)
open class GetCollectionVariables : IBaseRequest, IHasId, IHasTenantName, IGet
{
    @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
    override var id:UUID? = null

    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null

    /**
    * Include inherited variables
    */
    @ApiMember(Description="Include inherited variables", ParameterType="query")
    open var includeInherited:Boolean? = null
}

open class ItemsResponse<T>
{
    open var items:IList<VariableDto>? = null
    open var offset:Int? = null
    open var total:Int? = null
    open var isGrouped:Boolean? = null
    open var responseStatus:ResponseStatus? = null
    open var meta:HashMap<String,String>? = null
}

open class VariableDto
{
    open var name:String? = null
    /**
    * 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
    */
    open var value:String? = null
    /**
    * The data type of the value property
    */
    @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,
}

Kotlin GetCollectionVariables 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/collections/{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"}}