ListFacetAttributes 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, "clouddirectory")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://clouddirectory.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"clouddirectory.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::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"Name","string")
CkJsonObject::ckUpdateString(json,"NextToken","string")
; The JSON request body created by the above code:
; {
; "MaxResults": number,
; "Name": "string",
; "NextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","ListFacetAttributes")
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","/amazonclouddirectory/2017-01-11/facet/attributes",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
BinaryValue.i
BooleanValue.i
DatetimeValue.i
NumberValue.s
StringValue.s
IsImmutable.i
v_String.s
v_Type.s
AttributeDefinitionType.s
TargetAttributeName.s
TargetFacetName.s
Name.s
RequiredBehavior.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Attributes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
BinaryValue = CkJsonObject::ckIntOf(jResp,"Attributes[i].AttributeDefinition.DefaultValue.BinaryValue")
BooleanValue = CkJsonObject::ckIntOf(jResp,"Attributes[i].AttributeDefinition.DefaultValue.BooleanValue")
DatetimeValue = CkJsonObject::ckIntOf(jResp,"Attributes[i].AttributeDefinition.DefaultValue.DatetimeValue")
NumberValue = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeDefinition.DefaultValue.NumberValue")
StringValue = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeDefinition.DefaultValue.StringValue")
IsImmutable = CkJsonObject::ckIntOf(jResp,"Attributes[i].AttributeDefinition.IsImmutable")
v_String = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeDefinition.Rules.string.Parameters.string")
v_Type = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeDefinition.Rules.string.Type")
AttributeDefinitionType = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeDefinition.Type")
TargetAttributeName = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeReference.TargetAttributeName")
TargetFacetName = CkJsonObject::ckStringOf(jResp,"Attributes[i].AttributeReference.TargetFacetName")
Name = CkJsonObject::ckStringOf(jResp,"Attributes[i].Name")
RequiredBehavior = CkJsonObject::ckStringOf(jResp,"Attributes[i].RequiredBehavior")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Attributes": [
; {
; "AttributeDefinition": {
; "DefaultValue": {
; "BinaryValue": blob,
; "BooleanValue": boolean,
; "DatetimeValue": number,
; "NumberValue": "string",
; "StringValue": "string"
; },
; "IsImmutable": boolean,
; "Rules": {
; "string": {
; "Parameters": {
; "string": "string"
; },
; "Type": "string"
; }
; },
; "Type": "string"
; },
; "AttributeReference": {
; "TargetAttributeName": "string",
; "TargetFacetName": "string"
; },
; "Name": "string",
; "RequiredBehavior": "string"
; }
; ],
; "NextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
