ScheduleRun 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, "devicefarm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://devicefarm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"devicefarm.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,"appArn","string")
CkJsonObject::ckUpdateString(json,"configuration.auxiliaryApps[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.billingMethod","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.androidPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.deviceHostPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.iosPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.extraDataPackageArn","string")
CkJsonObject::ckUpdateString(json,"configuration.locale","string")
CkJsonObject::ckUpdateInt(json,"configuration.location.latitude",123)
CkJsonObject::ckUpdateInt(json,"configuration.location.longitude",123)
CkJsonObject::ckUpdateString(json,"configuration.networkProfileArn","string")
CkJsonObject::ckUpdateInt(json,"configuration.radios.bluetooth",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.gps",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.nfc",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.wifi",123)
CkJsonObject::ckUpdateString(json,"configuration.vpceConfigurationArns[0]","string")
CkJsonObject::ckUpdateString(json,"devicePoolArn","string")
CkJsonObject::ckUpdateString(json,"deviceSelectionConfiguration.filters[0].attribute","string")
CkJsonObject::ckUpdateString(json,"deviceSelectionConfiguration.filters[0].operator","string")
CkJsonObject::ckUpdateString(json,"deviceSelectionConfiguration.filters[0].values[0]","string")
CkJsonObject::ckUpdateInt(json,"deviceSelectionConfiguration.maxDevices",123)
CkJsonObject::ckUpdateInt(json,"executionConfiguration.accountsCleanup",123)
CkJsonObject::ckUpdateInt(json,"executionConfiguration.appPackagesCleanup",123)
CkJsonObject::ckUpdateInt(json,"executionConfiguration.jobTimeoutMinutes",123)
CkJsonObject::ckUpdateInt(json,"executionConfiguration.skipAppResign",123)
CkJsonObject::ckUpdateInt(json,"executionConfiguration.videoCapture",123)
CkJsonObject::ckUpdateString(json,"name","string")
CkJsonObject::ckUpdateString(json,"projectArn","string")
CkJsonObject::ckUpdateString(json,"test.filter","string")
CkJsonObject::ckUpdateString(json,"test.parameters.string","string")
CkJsonObject::ckUpdateString(json,"test.testPackageArn","string")
CkJsonObject::ckUpdateString(json,"test.testSpecArn","string")
CkJsonObject::ckUpdateString(json,"test.type","string")
; The JSON request body created by the above code:
; {
; "appArn": "string",
; "configuration": {
; "auxiliaryApps": [
; "string"
; ],
; "billingMethod": "string",
; "customerArtifactPaths": {
; "androidPaths": [
; "string"
; ],
; "deviceHostPaths": [
; "string"
; ],
; "iosPaths": [
; "string"
; ]
; },
; "extraDataPackageArn": "string",
; "locale": "string",
; "location": {
; "latitude": number,
; "longitude": number
; },
; "networkProfileArn": "string",
; "radios": {
; "bluetooth": boolean,
; "gps": boolean,
; "nfc": boolean,
; "wifi": boolean
; },
; "vpceConfigurationArns": [
; "string"
; ]
; },
; "devicePoolArn": "string",
; "deviceSelectionConfiguration": {
; "filters": [
; {
; "attribute": "string",
; "operator": "string",
; "values": [
; "string"
; ]
; }
; ],
; "maxDevices": number
; },
; "executionConfiguration": {
; "accountsCleanup": boolean,
; "appPackagesCleanup": boolean,
; "jobTimeoutMinutes": number,
; "skipAppResign": boolean,
; "videoCapture": boolean
; },
; "name": "string",
; "projectArn": "string",
; "test": {
; "filter": "string",
; "parameters": {
; "string": "string"
; },
; "testPackageArn": "string",
; "testSpecArn": "string",
; "type": "string"
; }
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DeviceFarm_20150623.ScheduleRun")
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
strVal.s
attribute.s
operator.s
j.i
count_j.i
AppUpload.s = CkJsonObject::ckStringOf(jResp,"run.appUpload")
Arn.s = CkJsonObject::ckStringOf(jResp,"run.arn")
BillingMethod.s = CkJsonObject::ckStringOf(jResp,"run.billingMethod")
CompletedJobs.i = CkJsonObject::ckIntOf(jResp,"run.completedJobs")
Errored.i = CkJsonObject::ckIntOf(jResp,"run.counters.errored")
Failed.i = CkJsonObject::ckIntOf(jResp,"run.counters.failed")
Passed.i = CkJsonObject::ckIntOf(jResp,"run.counters.passed")
Skipped.i = CkJsonObject::ckIntOf(jResp,"run.counters.skipped")
Stopped.i = CkJsonObject::ckIntOf(jResp,"run.counters.stopped")
Total.i = CkJsonObject::ckIntOf(jResp,"run.counters.total")
Warned.i = CkJsonObject::ckIntOf(jResp,"run.counters.warned")
Created.i = CkJsonObject::ckIntOf(jResp,"run.created")
Metered.i = CkJsonObject::ckIntOf(jResp,"run.deviceMinutes.metered")
DeviceMinutesTotal.i = CkJsonObject::ckIntOf(jResp,"run.deviceMinutes.total")
Unmetered.i = CkJsonObject::ckIntOf(jResp,"run.deviceMinutes.unmetered")
DevicePoolArn.s = CkJsonObject::ckStringOf(jResp,"run.devicePoolArn")
MatchedDevicesCount.i = CkJsonObject::ckIntOf(jResp,"run.deviceSelectionResult.matchedDevicesCount")
MaxDevices.i = CkJsonObject::ckIntOf(jResp,"run.deviceSelectionResult.maxDevices")
EventCount.i = CkJsonObject::ckIntOf(jResp,"run.eventCount")
JobTimeoutMinutes.i = CkJsonObject::ckIntOf(jResp,"run.jobTimeoutMinutes")
Locale.s = CkJsonObject::ckStringOf(jResp,"run.locale")
Latitude.i = CkJsonObject::ckIntOf(jResp,"run.location.latitude")
Longitude.i = CkJsonObject::ckIntOf(jResp,"run.location.longitude")
Message.s = CkJsonObject::ckStringOf(jResp,"run.message")
Name.s = CkJsonObject::ckStringOf(jResp,"run.name")
NetworkProfileArn.s = CkJsonObject::ckStringOf(jResp,"run.networkProfile.arn")
Description.s = CkJsonObject::ckStringOf(jResp,"run.networkProfile.description")
DownlinkBandwidthBits.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.downlinkBandwidthBits")
DownlinkDelayMs.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.downlinkDelayMs")
DownlinkJitterMs.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.downlinkJitterMs")
DownlinkLossPercent.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.downlinkLossPercent")
NetworkProfileName.s = CkJsonObject::ckStringOf(jResp,"run.networkProfile.name")
v_Type.s = CkJsonObject::ckStringOf(jResp,"run.networkProfile.type")
UplinkBandwidthBits.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.uplinkBandwidthBits")
UplinkDelayMs.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.uplinkDelayMs")
UplinkJitterMs.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.uplinkJitterMs")
UplinkLossPercent.i = CkJsonObject::ckIntOf(jResp,"run.networkProfile.uplinkLossPercent")
ParsingResultUrl.s = CkJsonObject::ckStringOf(jResp,"run.parsingResultUrl")
Platform.s = CkJsonObject::ckStringOf(jResp,"run.platform")
Bluetooth.i = CkJsonObject::ckIntOf(jResp,"run.radios.bluetooth")
Gps.i = CkJsonObject::ckIntOf(jResp,"run.radios.gps")
Nfc.i = CkJsonObject::ckIntOf(jResp,"run.radios.nfc")
Wifi.i = CkJsonObject::ckIntOf(jResp,"run.radios.wifi")
Result.s = CkJsonObject::ckStringOf(jResp,"run.result")
ResultCode.s = CkJsonObject::ckStringOf(jResp,"run.resultCode")
Seed.i = CkJsonObject::ckIntOf(jResp,"run.seed")
SkipAppResign.i = CkJsonObject::ckIntOf(jResp,"run.skipAppResign")
Started.i = CkJsonObject::ckIntOf(jResp,"run.started")
Status.s = CkJsonObject::ckStringOf(jResp,"run.status")
runStopped.i = CkJsonObject::ckIntOf(jResp,"run.stopped")
TestSpecArn.s = CkJsonObject::ckStringOf(jResp,"run.testSpecArn")
TotalJobs.i = CkJsonObject::ckIntOf(jResp,"run.totalJobs")
runType.s = CkJsonObject::ckStringOf(jResp,"run.type")
WebUrl.s = CkJsonObject::ckStringOf(jResp,"run.webUrl")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"run.customerArtifactPaths.androidPaths")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"run.customerArtifactPaths.androidPaths[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"run.customerArtifactPaths.deviceHostPaths")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"run.customerArtifactPaths.deviceHostPaths[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"run.customerArtifactPaths.iosPaths")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"run.customerArtifactPaths.iosPaths[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"run.deviceSelectionResult.filters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
attribute = CkJsonObject::ckStringOf(jResp,"run.deviceSelectionResult.filters[i].attribute")
operator = CkJsonObject::ckStringOf(jResp,"run.deviceSelectionResult.filters[i].operator")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"run.deviceSelectionResult.filters[i].values")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"run.deviceSelectionResult.filters[i].values[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "run": {
; "appUpload": "string",
; "arn": "string",
; "billingMethod": "string",
; "completedJobs": number,
; "counters": {
; "errored": number,
; "failed": number,
; "passed": number,
; "skipped": number,
; "stopped": number,
; "total": number,
; "warned": number
; },
; "created": number,
; "customerArtifactPaths": {
; "androidPaths": [
; "string"
; ],
; "deviceHostPaths": [
; "string"
; ],
; "iosPaths": [
; "string"
; ]
; },
; "deviceMinutes": {
; "metered": number,
; "total": number,
; "unmetered": number
; },
; "devicePoolArn": "string",
; "deviceSelectionResult": {
; "filters": [
; {
; "attribute": "string",
; "operator": "string",
; "values": [
; "string"
; ]
; }
; ],
; "matchedDevicesCount": number,
; "maxDevices": number
; },
; "eventCount": number,
; "jobTimeoutMinutes": number,
; "locale": "string",
; "location": {
; "latitude": number,
; "longitude": number
; },
; "message": "string",
; "name": "string",
; "networkProfile": {
; "arn": "string",
; "description": "string",
; "downlinkBandwidthBits": number,
; "downlinkDelayMs": number,
; "downlinkJitterMs": number,
; "downlinkLossPercent": number,
; "name": "string",
; "type": "string",
; "uplinkBandwidthBits": number,
; "uplinkDelayMs": number,
; "uplinkJitterMs": number,
; "uplinkLossPercent": number
; },
; "parsingResultUrl": "string",
; "platform": "string",
; "radios": {
; "bluetooth": boolean,
; "gps": boolean,
; "nfc": boolean,
; "wifi": boolean
; },
; "result": "string",
; "resultCode": "string",
; "seed": number,
; "skipAppResign": boolean,
; "started": number,
; "status": "string",
; "stopped": number,
; "testSpecArn": "string",
; "totalJobs": number,
; "type": "string",
; "webUrl": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
