Ruby

List Plans for a Group

See more Microsoft Tasks and Plans Examples

Demonstrates how to retrieve a list of plannerPlan objects owned by a group object.

See https://docs.microsoft.com/en-us/graph/api/plannergroup-list-plans?view=graph-rest-1.0 for more information.

Ruby

require 'chilkat'

success = false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# The Microsoft Planner REST API requires an OAuth2 token with the Group.ReadWrite.All scope.
# Use your previously obtained access token as shown here:
#    Get Microsoft Graph OAuth2 Access Token with Group.ReadWrite.All scope.

jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/msGraphGroup.json")
if (success == false)
    print jsonToken.lastErrorText() + "\n";
    exit
end

http.put_AuthToken(jsonToken.stringOf("access_token"))

# Send a GET request to https://graph.microsoft.com/v1.0/groups/{group-id}/planner/plans
strResponse = http.quickGetStr("https://graph.microsoft.com/v1.0/groups/{group-id}/planner/plans")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.Load(strResponse)
json.put_EmitCompact(false)

if (http.get_LastStatus() != 200)
    print json.emit() + "\n";
    print "Failed, response status code = " + http.get_LastStatus().to_s() + "\n";
    exit
end

print json.emit() + "\n";

# Sample output:
# (See parsing code below..)

# {
#   "value": [
#     {
#       "createdBy": {
#         "application": {
#           "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
#         },
#         "user": {
#           "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
#         }
#       },
#       "createdDateTime": "2015-03-30T18:36:49.2407981Z",
#       "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
#       "title": "title-value",
#       "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
#     }
#   ]
# }

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

i = 0
count_i = json.SizeOfArray("value")
while i < count_i
    json.put_I(i)
    createdByApplicationId = json.stringOf("value[i].createdBy.application.id")
    createdByUserId = json.stringOf("value[i].createdBy.user.id")
    createdDateTime = json.stringOf("value[i].createdDateTime")
    owner = json.stringOf("value[i].owner")
    title = json.stringOf("value[i].title")
    id = json.stringOf("value[i].id")
    i = i + 1
end

print "Success." + "\n";