Chilkat Online Tools

PureBasic / Microsoft Graph / Create retentionLabel

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "displayName": "{{labelDisplayName}}",
    ;   "behaviorDuringRetentionPeriod": "retain",
    ;   "actionAfterRetentionPeriod": "none",
    ;   "retentionTrigger": "dateLabeled",
    ;   "retentionDuration": {
    ;     "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    ;     "days": "2555"
    ;   },
    ;   "descriptionForAdmins": "{{labelDescriptionForAdmins}}",
    ;   "descriptionForUsers": "{{labelDescriptionForUsers}}"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"displayName","{{labelDisplayName}}")
    CkJsonObject::ckUpdateString(json,"behaviorDuringRetentionPeriod","retain")
    CkJsonObject::ckUpdateString(json,"actionAfterRetentionPeriod","none")
    CkJsonObject::ckUpdateString(json,"retentionTrigger","dateLabeled")
    CkJsonObject::ckUpdateString(json,"retentionDuration." + Chr(34) + "@odata.type" + Chr(34),"microsoft.graph.security.retentionDurationInDays")
    CkJsonObject::ckUpdateString(json,"retentionDuration.days","2555")
    CkJsonObject::ckUpdateString(json,"descriptionForAdmins","{{labelDescriptionForAdmins}}")
    CkJsonObject::ckUpdateString(json,"descriptionForUsers","{{labelDescriptionForUsers}}")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"POST","https://graph.microsoft.com/beta/security/labels/retentionLabels",json,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "displayName": "{{labelDisplayName}}",
  "behaviorDuringRetentionPeriod": "retain",
  "actionAfterRetentionPeriod": "none",
  "retentionTrigger": "dateLabeled",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": "2555"
  },
  "descriptionForAdmins": "{{labelDescriptionForAdmins}}",
  "descriptionForUsers": "{{labelDescriptionForUsers}}"
}'
https://graph.microsoft.com/beta/security/labels/retentionLabels

Postman Collection Item JSON

{
  "name": "Create retentionLabel",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var json = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"retentionLabelId\", json.id);"
        ]
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"displayName\": \"{{labelDisplayName}}\",\n  \"behaviorDuringRetentionPeriod\": \"retain\",\n  \"actionAfterRetentionPeriod\": \"none\",\n  \"retentionTrigger\": \"dateLabeled\",\n  \"retentionDuration\": {\n    \"@odata.type\": \"microsoft.graph.security.retentionDurationInDays\",\n    \"days\": \"2555\"\n  },\n  \"descriptionForAdmins\": \"{{labelDescriptionForAdmins}}\",\n  \"descriptionForUsers\": \"{{labelDescriptionForUsers}}\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://graph.microsoft.com/beta/security/labels/retentionLabels",
      "protocol": "https",
      "host": [
        "graph",
        "microsoft",
        "com"
      ],
      "path": [
        "beta",
        "security",
        "labels",
        "retentionLabels"
      ]
    }
  },
  "response": [
  ]
}