CoreService

<back to all web services

GenerateDeploymentName

Deployment - CRUD

Generate deployment name with the user defined part

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
PATCH/api/deployments/generation/nameGenerate deployment name with the user defined part
PATCH/deployments/generation/nameGenerate deployment name with the user defined part
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Deployments.Crud
Imports CoreService.ServiceModel.Enums

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.Deployments.Crud

        '''<Summary>
        '''Generate deployment name with the user defined part
        '''</Summary>
        <Api(Description:="Generate deployment name with the user defined part")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(String), StatusCode:=200)>
        Public Partial Class GenerateDeploymentName
            Implements IBaseRequest
            Implements IHasTenantName
            Implements IPatch
            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property TenantName As String Implements IHasTenantName.TenantName

            '''<Summary>
            '''User defined/custom part of the name
            '''</Summary>
            <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]+$′)")>
            Public Overridable Property UserDefinedPart As String

            '''<Summary>
            '''What kind of environment is this deployment
            '''</Summary>
            <ApiMember(Description:="What kind of environment is this deployment", IsRequired:=true, ParameterType:="body")>
            Public Overridable Property Environment As Environments
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Enums

        Public Enum Environments
            Lab
            Poc
            Dev
            Test
            Int
            Uat
            Prod
        End Enum
    End Namespace
End Namespace

VB.NET 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

HTTP + JSON

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)