| Required role: | TenantReader |
| PATCH | /api/deployments/generation/name | Generate deployment name with the user defined part | |
|---|---|---|---|
| PATCH | /deployments/generation/name | Generate deployment name with the user defined part |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Generate deployment name with the user defined part
*/
@Api(Description="Generate deployment name with the user defined part")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=String::class, StatusCode=200)
open class GenerateDeploymentName : IBaseRequest, IHasTenantName, IPatch
{
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
override var tenantName:String? = null
/**
* User defined/custom part of the name
*/
@ApiMember(DataType="string", Description="User defined/custom part of the name", IsRequired=true, ParameterType="body")
@Validate(Validator="NotEmpty")
// @Validate(Validator="MaximumLength(100)")
// @Validate(Validator="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")
open var userDefinedPart:String? = null
/**
* What kind of environment is this deployment
*/
@ApiMember(Description="What kind of environment is this deployment", IsRequired=true, ParameterType="body")
open var environment:Environments? = null
}
enum class Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
Kotlin GenerateDeploymentName 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.
PATCH /api/deployments/generation/name HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tenantName":"String","userDefinedPart":"String","environment":"Lab","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length (string)