CoreService

<back to all web services

ValidateDeploymentName

Deployment - CRUD

Validate deployment name with the user defined part

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
PATCH/api/deployments/validation/nameValidate deployment name with the user defined part
PATCH/deployments/validation/nameValidate deployment name with the user defined part
ValidateDeploymentName Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
NamebodystringYesThe full name in the form of '{userdefined}_{environment}'
EnvironmentbodyEnvironmentsYesWhat kind of environment is this deployment

Allowable Values

  • Lab
  • Poc
  • Dev
  • Test
  • Int
  • Uat
  • Prod
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod
ValidationResult Parameters:
NameParameterData TypeRequiredDescription
IsValidformboolNo
ErrorsformIList<ValidationFailure>No
RuleSetsExecutedformstring[]No
RequestformIRequestNo
ValidationFailure Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
ErrorMessageformstringNo
AttemptedValueformObjectNo
CustomStateformObjectNo
SeverityformSeverityNo
FormattedMessageArgumentsformObject[]No
FormattedMessagePlaceholderValuesformDictionary<string, Object>No
ErrorCodeformstringNo
Severity Enum:
Error
Warning
Info
IRequest Parameters:
NameParameterData TypeRequiredDescription
OriginalRequestformObjectNo
ResponseformIResponseNo
OperationNameformstringNo
VerbformstringNo
RequestAttributesformRequestAttributesNo
RequestPreferencesformIRequestPreferencesNo
DtoformObjectNo
ContentTypeformstringNo
IsLocalformboolNo
UserAgentformstringNo
CookiesformIDictionary<string, Cookie>No
ResponseContentTypeformstringNo
HasExplicitResponseContentTypeformboolNo
ItemsformDictionary<string, Object>No
HeadersformNameValueCollectionNo
QueryStringformNameValueCollectionNo
FormDataformNameValueCollectionNo
UseBufferedStreamformboolNo
RawUrlformstringNo
AbsoluteUriformstringNo
UserHostAddressformstringNo
RemoteIpformstringNo
AuthorizationformstringNo
IsSecureConnectionformboolNo
AcceptTypesformstring[]No
PathInfoformstringNo
OriginalPathInfoformstringNo
InputStreamformStreamNo
ContentLengthformlongNo
FilesformIHttpFile[]No
UrlReferrerformUriNo
IResponse Parameters:
NameParameterData TypeRequiredDescription
OriginalResponseformObjectNo
RequestformIRequestNo
StatusCodeformintNo
StatusDescriptionformstringNo
ContentTypeformstringNo
OutputStreamformStreamNo
DtoformObjectNo
UseBufferedStreamformboolNo
IsClosedformboolNo
KeepAliveformboolNo
HasStartedformboolNo
ItemsformDictionary<string, Object>No
RequestAttributes Enum:
NameValue
None0
Localhost1
LocalSubnet2
External4
Secure8
InSecure16
AnySecurityMode24
HttpHead32
HttpGet64
HttpPost128
HttpPut256
HttpDelete512
HttpPatch1024
HttpOptions2048
HttpOther4096
AnyHttpMethod8160
OneWay8192
Reply16384
AnyCallStyle24576
Soap1132768
Soap1265536
Xml131072
Json262144
Jsv524288
ProtoBuf1048576
Csv2097152
Html4194304
Jsonl8388608
MsgPack16777216
FormatOther33554432
AnyFormat67076096
Http67108864
MessageQueue134217728
Tcp268435456
Grpc536870912
EndpointOther1073741824
AnyEndpoint2080374784
InProcess-2147483648
InternalNetworkAccess-2147483645
AnyNetworkAccessType-2147483641
Any-1
IRequestPreferences Parameters:
NameParameterData TypeRequiredDescription
AcceptsBrotliformboolNo
AcceptsDeflateformboolNo
AcceptsGzipformboolNo
IHttpFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileNameformstringNo
ContentLengthformlongNo
ContentTypeformstringNo
InputStreamformStreamNo

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/validation/name HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","name":"String","environment":"Lab","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"isValid":true,"errors":[],"ruleSetsExecuted":["String"],"request":null}