GetTemplateSyncStatus 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, "proton")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://proton.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"proton.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,"templateName","string")
CkJsonObject::ckUpdateString(json,"templateType","string")
CkJsonObject::ckUpdateString(json,"templateVersion","string")
; The JSON request body created by the above code:
; {
; "templateName": "string",
; "templateType": "string",
; "templateVersion": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","AwsProton20200720.GetTemplateSyncStatus")
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","/",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
v_event.s
externalId.s
time.i
v_type.s
Branch.s = CkJsonObject::ckStringOf(jResp,"desiredState.branch")
Directory.s = CkJsonObject::ckStringOf(jResp,"desiredState.directory")
RepositoryName.s = CkJsonObject::ckStringOf(jResp,"desiredState.repositoryName")
RepositoryProvider.s = CkJsonObject::ckStringOf(jResp,"desiredState.repositoryProvider")
Sha.s = CkJsonObject::ckStringOf(jResp,"desiredState.sha")
InitialRevisionBranch.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.initialRevision.branch")
InitialRevisionDirectory.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.initialRevision.directory")
InitialRevisionRepositoryName.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.initialRevision.repositoryName")
InitialRevisionRepositoryProvider.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.initialRevision.repositoryProvider")
InitialRevisionSha.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.initialRevision.sha")
StartedAt.i = CkJsonObject::ckIntOf(jResp,"latestSuccessfulSync.startedAt")
Status.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.status")
Target.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.target")
TargetRevisionBranch.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.targetRevision.branch")
TargetRevisionDirectory.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.targetRevision.directory")
TargetRevisionRepositoryName.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.targetRevision.repositoryName")
TargetRevisionRepositoryProvider.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.targetRevision.repositoryProvider")
TargetRevisionSha.s = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.targetRevision.sha")
InitialRevisionBranch = CkJsonObject::ckStringOf(jResp,"latestSync.initialRevision.branch")
InitialRevisionDirectory = CkJsonObject::ckStringOf(jResp,"latestSync.initialRevision.directory")
InitialRevisionRepositoryName = CkJsonObject::ckStringOf(jResp,"latestSync.initialRevision.repositoryName")
InitialRevisionRepositoryProvider = CkJsonObject::ckStringOf(jResp,"latestSync.initialRevision.repositoryProvider")
InitialRevisionSha = CkJsonObject::ckStringOf(jResp,"latestSync.initialRevision.sha")
latestSyncStartedAt.i = CkJsonObject::ckIntOf(jResp,"latestSync.startedAt")
latestSyncStatus.s = CkJsonObject::ckStringOf(jResp,"latestSync.status")
latestSyncTarget.s = CkJsonObject::ckStringOf(jResp,"latestSync.target")
TargetRevisionBranch = CkJsonObject::ckStringOf(jResp,"latestSync.targetRevision.branch")
TargetRevisionDirectory = CkJsonObject::ckStringOf(jResp,"latestSync.targetRevision.directory")
TargetRevisionRepositoryName = CkJsonObject::ckStringOf(jResp,"latestSync.targetRevision.repositoryName")
TargetRevisionRepositoryProvider = CkJsonObject::ckStringOf(jResp,"latestSync.targetRevision.repositoryProvider")
TargetRevisionSha = CkJsonObject::ckStringOf(jResp,"latestSync.targetRevision.sha")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"latestSuccessfulSync.events")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_event = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.events[i].event")
externalId = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.events[i].externalId")
time = CkJsonObject::ckIntOf(jResp,"latestSuccessfulSync.events[i].time")
v_type = CkJsonObject::ckStringOf(jResp,"latestSuccessfulSync.events[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"latestSync.events")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_event = CkJsonObject::ckStringOf(jResp,"latestSync.events[i].event")
externalId = CkJsonObject::ckStringOf(jResp,"latestSync.events[i].externalId")
time = CkJsonObject::ckIntOf(jResp,"latestSync.events[i].time")
v_type = CkJsonObject::ckStringOf(jResp,"latestSync.events[i].type")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "desiredState": {
; "branch": "string",
; "directory": "string",
; "repositoryName": "string",
; "repositoryProvider": "string",
; "sha": "string"
; },
; "latestSuccessfulSync": {
; "events": [
; {
; "event": "string",
; "externalId": "string",
; "time": number,
; "type": "string"
; }
; ],
; "initialRevision": {
; "branch": "string",
; "directory": "string",
; "repositoryName": "string",
; "repositoryProvider": "string",
; "sha": "string"
; },
; "startedAt": number,
; "status": "string",
; "target": "string",
; "targetRevision": {
; "branch": "string",
; "directory": "string",
; "repositoryName": "string",
; "repositoryProvider": "string",
; "sha": "string"
; }
; },
; "latestSync": {
; "events": [
; {
; "event": "string",
; "externalId": "string",
; "time": number,
; "type": "string"
; }
; ],
; "initialRevision": {
; "branch": "string",
; "directory": "string",
; "repositoryName": "string",
; "repositoryProvider": "string",
; "sha": "string"
; },
; "startedAt": number,
; "status": "string",
; "target": "string",
; "targetRevision": {
; "branch": "string",
; "directory": "string",
; "repositoryName": "string",
; "repositoryProvider": "string",
; "sha": "string"
; }
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
