CreateCustomActionType 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, "codepipeline")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://codepipeline.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"codepipeline.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,"category","string")
CkJsonObject::ckUpdateString(json,"configurationProperties[0].description","string")
CkJsonObject::ckUpdateInt(json,"configurationProperties[0].key",123)
CkJsonObject::ckUpdateString(json,"configurationProperties[0].name","string")
CkJsonObject::ckUpdateInt(json,"configurationProperties[0].queryable",123)
CkJsonObject::ckUpdateInt(json,"configurationProperties[0].required",123)
CkJsonObject::ckUpdateInt(json,"configurationProperties[0].secret",123)
CkJsonObject::ckUpdateString(json,"configurationProperties[0].type","string")
CkJsonObject::ckUpdateInt(json,"inputArtifactDetails.maximumCount",123)
CkJsonObject::ckUpdateInt(json,"inputArtifactDetails.minimumCount",123)
CkJsonObject::ckUpdateInt(json,"outputArtifactDetails.maximumCount",123)
CkJsonObject::ckUpdateInt(json,"outputArtifactDetails.minimumCount",123)
CkJsonObject::ckUpdateString(json,"provider","string")
CkJsonObject::ckUpdateString(json,"settings.entityUrlTemplate","string")
CkJsonObject::ckUpdateString(json,"settings.executionUrlTemplate","string")
CkJsonObject::ckUpdateString(json,"settings.revisionUrlTemplate","string")
CkJsonObject::ckUpdateString(json,"settings.thirdPartyConfigurationUrl","string")
CkJsonObject::ckUpdateString(json,"tags[0].key","string")
CkJsonObject::ckUpdateString(json,"tags[0].value","string")
CkJsonObject::ckUpdateString(json,"version","string")
; The JSON request body created by the above code:
; {
; "category": "string",
; "configurationProperties": [
; {
; "description": "string",
; "key": boolean,
; "name": "string",
; "queryable": boolean,
; "required": boolean,
; "secret": boolean,
; "type": "string"
; }
; ],
; "inputArtifactDetails": {
; "maximumCount": number,
; "minimumCount": number
; },
; "outputArtifactDetails": {
; "maximumCount": number,
; "minimumCount": number
; },
; "provider": "string",
; "settings": {
; "entityUrlTemplate": "string",
; "executionUrlTemplate": "string",
; "revisionUrlTemplate": "string",
; "thirdPartyConfigurationUrl": "string"
; },
; "tags": [
; {
; "key": "string",
; "value": "string"
; }
; ],
; "version": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","CodePipeline_20150709.CreateCustomActionType")
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
description.s
key.i
name.s
queryable.i
required.i
secret.i
v_type.s
key_str.s
value.s
Category.s = CkJsonObject::ckStringOf(jResp,"actionType.id.category")
Owner.s = CkJsonObject::ckStringOf(jResp,"actionType.id.owner")
Provider.s = CkJsonObject::ckStringOf(jResp,"actionType.id.provider")
Version.s = CkJsonObject::ckStringOf(jResp,"actionType.id.version")
MaximumCount.i = CkJsonObject::ckIntOf(jResp,"actionType.inputArtifactDetails.maximumCount")
MinimumCount.i = CkJsonObject::ckIntOf(jResp,"actionType.inputArtifactDetails.minimumCount")
OutputArtifactDetailsMaximumCount.i = CkJsonObject::ckIntOf(jResp,"actionType.outputArtifactDetails.maximumCount")
OutputArtifactDetailsMinimumCount.i = CkJsonObject::ckIntOf(jResp,"actionType.outputArtifactDetails.minimumCount")
EntityUrlTemplate.s = CkJsonObject::ckStringOf(jResp,"actionType.settings.entityUrlTemplate")
ExecutionUrlTemplate.s = CkJsonObject::ckStringOf(jResp,"actionType.settings.executionUrlTemplate")
RevisionUrlTemplate.s = CkJsonObject::ckStringOf(jResp,"actionType.settings.revisionUrlTemplate")
ThirdPartyConfigurationUrl.s = CkJsonObject::ckStringOf(jResp,"actionType.settings.thirdPartyConfigurationUrl")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"actionType.actionConfigurationProperties")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"actionType.actionConfigurationProperties[i].description")
key = CkJsonObject::ckIntOf(jResp,"actionType.actionConfigurationProperties[i].key")
name = CkJsonObject::ckStringOf(jResp,"actionType.actionConfigurationProperties[i].name")
queryable = CkJsonObject::ckIntOf(jResp,"actionType.actionConfigurationProperties[i].queryable")
required = CkJsonObject::ckIntOf(jResp,"actionType.actionConfigurationProperties[i].required")
secret = CkJsonObject::ckIntOf(jResp,"actionType.actionConfigurationProperties[i].secret")
v_type = CkJsonObject::ckStringOf(jResp,"actionType.actionConfigurationProperties[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
key_str = CkJsonObject::ckStringOf(jResp,"tags[i].key")
value = CkJsonObject::ckStringOf(jResp,"tags[i].value")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "actionType": {
; "actionConfigurationProperties": [
; {
; "description": "string",
; "key": boolean,
; "name": "string",
; "queryable": boolean,
; "required": boolean,
; "secret": boolean,
; "type": "string"
; }
; ],
; "id": {
; "category": "string",
; "owner": "string",
; "provider": "string",
; "version": "string"
; },
; "inputArtifactDetails": {
; "maximumCount": number,
; "minimumCount": number
; },
; "outputArtifactDetails": {
; "maximumCount": number,
; "minimumCount": number
; },
; "settings": {
; "entityUrlTemplate": "string",
; "executionUrlTemplate": "string",
; "revisionUrlTemplate": "string",
; "thirdPartyConfigurationUrl": "string"
; }
; },
; "tags": [
; {
; "key": "string",
; "value": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
