CreateWorkspace PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "grafana")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://grafana.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"grafana.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; The following code creates the JSON request body.
; The JSON created by this code is shown below.
; Use this online tool to generate code from sample JSON:
; Generate Code to Create JSON
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"accountAccessType","string")
CkJsonObject::ckUpdateString(json,"authenticationProviders[0]","string")
CkJsonObject::ckUpdateString(json,"clientToken","string")
CkJsonObject::ckUpdateString(json,"organizationRoleName","string")
CkJsonObject::ckUpdateString(json,"permissionType","string")
CkJsonObject::ckUpdateString(json,"stackSetName","string")
CkJsonObject::ckUpdateString(json,"tags.string","string")
CkJsonObject::ckUpdateString(json,"workspaceDataSources[0]","string")
CkJsonObject::ckUpdateString(json,"workspaceDescription","string")
CkJsonObject::ckUpdateString(json,"workspaceName","string")
CkJsonObject::ckUpdateString(json,"workspaceNotificationDestinations[0]","string")
CkJsonObject::ckUpdateString(json,"workspaceOrganizationalUnits[0]","string")
CkJsonObject::ckUpdateString(json,"workspaceRoleArn","string")
; The JSON request body created by the above code:
; {
; "accountAccessType": "string",
; "authenticationProviders": [
; "string"
; ],
; "clientToken": "string",
; "organizationRoleName": "string",
; "permissionType": "string",
; "stackSetName": "string",
; "tags": {
; "string": "string"
; },
; "workspaceDataSources": [
; "string"
; ],
; "workspaceDescription": "string",
; "workspaceName": "string",
; "workspaceNotificationDestinations": [
; "string"
; ],
; "workspaceOrganizationalUnits": [
; "string"
; ],
; "workspaceRoleArn": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","CreateWorkspace")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/workspaces",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
; The following code parses the JSON response.
; A sample JSON response is shown below the sample code.
; Use this online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON
strVal.s
AccountAccessType.s = CkJsonObject::ckStringOf(jResp,"workspace.accountAccessType")
SamlConfigurationStatus.s = CkJsonObject::ckStringOf(jResp,"workspace.authentication.samlConfigurationStatus")
Created.i = CkJsonObject::ckIntOf(jResp,"workspace.created")
Description.s = CkJsonObject::ckStringOf(jResp,"workspace.description")
Endpoint.s = CkJsonObject::ckStringOf(jResp,"workspace.endpoint")
FreeTrialConsumed.i = CkJsonObject::ckIntOf(jResp,"workspace.freeTrialConsumed")
FreeTrialExpiration.i = CkJsonObject::ckIntOf(jResp,"workspace.freeTrialExpiration")
GrafanaVersion.s = CkJsonObject::ckStringOf(jResp,"workspace.grafanaVersion")
Id.s = CkJsonObject::ckStringOf(jResp,"workspace.id")
LicenseExpiration.i = CkJsonObject::ckIntOf(jResp,"workspace.licenseExpiration")
LicenseType.s = CkJsonObject::ckStringOf(jResp,"workspace.licenseType")
Modified.i = CkJsonObject::ckIntOf(jResp,"workspace.modified")
Name.s = CkJsonObject::ckStringOf(jResp,"workspace.name")
OrganizationRoleName.s = CkJsonObject::ckStringOf(jResp,"workspace.organizationRoleName")
PermissionType.s = CkJsonObject::ckStringOf(jResp,"workspace.permissionType")
StackSetName.s = CkJsonObject::ckStringOf(jResp,"workspace.stackSetName")
Status.s = CkJsonObject::ckStringOf(jResp,"workspace.status")
v_String.s = CkJsonObject::ckStringOf(jResp,"workspace.tags.string")
WorkspaceRoleArn.s = CkJsonObject::ckStringOf(jResp,"workspace.workspaceRoleArn")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"workspace.authentication.providers")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"workspace.authentication.providers[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.dataSources")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"workspace.dataSources[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.notificationDestinations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"workspace.notificationDestinations[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.organizationalUnits")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"workspace.organizationalUnits[i]")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "workspace": {
; "accountAccessType": "string",
; "authentication": {
; "providers": [
; "string"
; ],
; "samlConfigurationStatus": "string"
; },
; "created": number,
; "dataSources": [
; "string"
; ],
; "description": "string",
; "endpoint": "string",
; "freeTrialConsumed": boolean,
; "freeTrialExpiration": number,
; "grafanaVersion": "string",
; "id": "string",
; "licenseExpiration": number,
; "licenseType": "string",
; "modified": number,
; "name": "string",
; "notificationDestinations": [
; "string"
; ],
; "organizationalUnits": [
; "string"
; ],
; "organizationRoleName": "string",
; "permissionType": "string",
; "stackSetName": "string",
; "status": "string",
; "tags": {
; "string": "string"
; },
; "workspaceRoleArn": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
