Policy Management API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Please note this API is only available if you have deployed and configured MongoDB with the Glasswall Halo

Authentication

HTTP Authentication, scheme: basic
HTTP Authentication, scheme: Bearer

PolicyManagement

Create Policy

Code samples

# You can also use wget
curl -X POST /api/v1/policies/{policyName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/v1/policies/{policyName} HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "status": "string",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/policies/{policyName}

Creates a named policy with the provided values

Body parameter

{
  "status": "string",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to create
body	body	WritePolicyBody	true	none

Example responses

201 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/default",
  "locks": {
    "property1": {
      "locker": "string",
      "reason": "string"
    },
    "property2": {
      "locker": "string",
      "reason": "string"
    }
  }
}

400 Response

[
  "Duplicate policy name"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
201	Created	Policy Created	WritePolicyBodyResponse
400	Bad Request	Policy failed validation, reasons in response	PolicyError
403	Forbidden	Attempt to create ‘default’ policy	None
404	Not Found	Specified schema not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Update Policy

Code samples

# You can also use wget
curl -X PUT /api/v1/policies/{policyName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/v1/policies/{policyName} HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "status": "string",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/v1/policies/{policyName}

Updates a named policy with the provided values

Body parameter

{
  "status": "string",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to create
body	body	WritePolicyBody	true	none

Example responses

200 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/default"
}

400 Response

[
  "Duplicate policy name"
]

404 Response

[
  "Policy not found"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
200	OK	Policy Updated	ContentManagementPolicySummary
400	Bad Request	Policy failed validation, reasons in response	PolicyError
404	Not Found	Specified schema or policy not found	PolicyError
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Get Policy

Code samples

# You can also use wget
curl -X GET /api/v1/policies/{policyName} \
  -H 'Accept: application/json'

GET /api/v1/policies/{policyName} HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/policies/{policyName}

Gets a named policy

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to retrieve the details of

Example responses

200 Response

{
  "schemaName": "string",
  "policyName": "string",
  "policyIdentity": "string",
  "policyVersion": 0,
  "isDefaultPolicy": true,
  "locks": {
    "property1": {
      "locker": "string",
      "reason": "string"
    },
    "property2": {
      "locker": "string",
      "reason": "string"
    }
  },
  "status": "enabled",
  "schemaReferences": [
    {
      "schemaVersion": "string",
      "property": "string",
      "policyName": "string"
    }
  ],
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}

404 Response

[
  "Policy not found"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
200	OK	Policy found	GetPolicyResponse
404	Not Found	Specified schema or policy not found	PolicyError
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Delete Policy

Code samples

# You can also use wget
curl -X DELETE /api/v1/policies/{policyName} \
  -H 'Accept: application/json'

DELETE /api/v1/policies/{policyName} HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/v1/policies/{policyName}

Delete the specified policy

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to delete

Example responses

404 Response

[
  "Policy not found"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Attempt to delete ‘default’ policy	None
404	Not Found	Specified schema or policy not found	PolicyError
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Get All Policies

Code samples

# You can also use wget
curl -X GET /api/v1/policies \
  -H 'Accept: application/json'

GET /api/v1/policies HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/api/v1/policies',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v1/policies', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/policies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/policies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/policies

Gets a full list of all configured policies

Example responses

200 Response

[
  {
    "policyName": "default",
    "isDefaultPolicy": true
  }
]

404 Response

[
  "Policy not found"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
200	OK	A list of all policies	Inline
404	Not Found	Specified schema or policy not found	PolicyError
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ContentManagementPolicyListItem]	false	none	none
» policyName	string	false	none	none
» isDefaultPolicy	boolean	false	none	none

Reset Policy

Code samples

# You can also use wget
curl -X PUT /api/v1/policies/{policyName}/reset \
  -H 'Accept: application/json'

PUT /api/v1/policies/{policyName}/reset HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}/reset',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put '/api/v1/policies/{policyName}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v1/policies/{policyName}/reset', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/policies/{policyName}/reset', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}/reset");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/v1/policies/{policyName}/reset", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/v1/policies/{policyName}/reset

Resets a named policy to the default schema values

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to reset

Example responses

200 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/default"
}

400 Response

[
  "Duplicate policy name"
]

404 Response

[
  "Policy not found"
]

500 Response

[
  "Processing error"
]

Responses

Status	Meaning	Description	Schema
200	OK	Policy Updated	ContentManagementPolicySummary
400	Bad Request	Policy failed validation, reasons in response	PolicyError
404	Not Found	Specified schema or policy not found	PolicyError
500	Internal Server Error	Issues occurred when attempting to access storage.	PolicyError

Schemas

PolicyError

[
  "string"
]

A list of errors which occurred during a profile request.

Properties

None

ContentManagementFlag

"sanitise"

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	allow
anonymous	sanitise
anonymous	disallow
anonymous	0
anonymous	1
anonymous	2

PdfContentManagement

{
  "acroform": "sanitise",
  "digitalSignatures": "sanitise",
  "embeddedFiles": "sanitise",
  "embeddedImages": "sanitise",
  "externalHyperlinks": "sanitise",
  "internalHyperlinks": "sanitise",
  "javascript": "sanitise",
  "metadata": "sanitise",
  "actionsAll": "sanitise",
  "retainExportedStreams": "sanitise",
  "valueOutsideReasonableLimits": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
acroform	ContentManagementFlag	false	none	none
digitalSignatures	ContentManagementFlag	false	none	none
embeddedFiles	ContentManagementFlag	false	none	none
embeddedImages	ContentManagementFlag	false	none	none
externalHyperlinks	ContentManagementFlag	false	none	none
internalHyperlinks	ContentManagementFlag	false	none	none
javascript	ContentManagementFlag	false	none	none
metadata	ContentManagementFlag	false	none	none
actionsAll	ContentManagementFlag	false	none	none
retainExportedStreams	ContentManagementFlag	false	none	none
valueOutsideReasonableLimits	ContentManagementFlag	false	none	none

WordContentManagement

{
  "dynamicDataExchange": "sanitise",
  "embeddedFiles": "sanitise",
  "embeddedImages": "sanitise",
  "externalHyperlinks": "sanitise",
  "hiddenData": "sanitise",
  "internalHyperlinks": "sanitise",
  "macros": "sanitise",
  "metadata": "sanitise",
  "reviewComments": "sanitise",
  "trackedChanges": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
dynamicDataExchange	ContentManagementFlag	false	none	none
embeddedFiles	ContentManagementFlag	false	none	none
embeddedImages	ContentManagementFlag	false	none	none
externalHyperlinks	ContentManagementFlag	false	none	none
hiddenData	ContentManagementFlag	false	none	none
internalHyperlinks	ContentManagementFlag	false	none	none
macros	ContentManagementFlag	false	none	none
metadata	ContentManagementFlag	false	none	none
reviewComments	ContentManagementFlag	false	none	none
trackedChanges	ContentManagementFlag	false	none	none

ExcelContentManagement

{
  "connections": "sanitise",
  "dynamicDataExchange": "sanitise",
  "embeddedFiles": "sanitise",
  "embeddedImages": "sanitise",
  "externalHyperlinks": "sanitise",
  "hiddenData": "sanitise",
  "internalHyperlinks": "sanitise",
  "macros": "sanitise",
  "metadata": "sanitise",
  "reviewComments": "sanitise",
  "trackedChanges": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
connections	ContentManagementFlag	false	none	none
dynamicDataExchange	ContentManagementFlag	false	none	none
embeddedFiles	ContentManagementFlag	false	none	none
embeddedImages	ContentManagementFlag	false	none	none
externalHyperlinks	ContentManagementFlag	false	none	none
hiddenData	ContentManagementFlag	false	none	none
internalHyperlinks	ContentManagementFlag	false	none	none
macros	ContentManagementFlag	false	none	none
metadata	ContentManagementFlag	false	none	none
reviewComments	ContentManagementFlag	false	none	none
trackedChanges	ContentManagementFlag	false	none	none

PowerPointContentManagement

{
  "embeddedFiles": "sanitise",
  "embeddedImages": "sanitise",
  "externalHyperlinks": "sanitise",
  "hiddenData": "sanitise",
  "internalHyperlinks": "sanitise",
  "macros": "sanitise",
  "metadata": "sanitise",
  "reviewComments": "sanitise",
  "slideNotes": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
embeddedFiles	ContentManagementFlag	false	none	none
embeddedImages	ContentManagementFlag	false	none	none
externalHyperlinks	ContentManagementFlag	false	none	none
hiddenData	ContentManagementFlag	false	none	none
internalHyperlinks	ContentManagementFlag	false	none	none
macros	ContentManagementFlag	false	none	none
metadata	ContentManagementFlag	false	none	none
reviewComments	ContentManagementFlag	false	none	none
slideNotes	ContentManagementFlag	false	none	none

SvgConfig

{
  "hyperlinks": "sanitise",
  "foreignObjects": "sanitise",
  "scripts": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
hyperlinks	ContentManagementFlag	false	none	none
foreignObjects	ContentManagementFlag	false	none	none
scripts	ContentManagementFlag	false	none	none

WebpConfig

{
  "metadata": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
metadata	ContentManagementFlag	false	none	none

TiffConfig

{
  "geoTiff": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
geoTiff	ContentManagementFlag	false	none	none

ArchiveConfig

{
  "bmp": "sanitise",
  "doc": "sanitise",
  "docx": "sanitise",
  "emf": "sanitise",
  "gif": "sanitise",
  "jpg": "sanitise",
  "wav": "sanitise",
  "elf": "sanitise",
  "pe": "sanitise",
  "mp4": "sanitise",
  "mpg": "sanitise",
  "pdf": "sanitise",
  "png": "sanitise",
  "ppt": "sanitise",
  "pptx": "sanitise",
  "tif": "sanitise",
  "wmf": "sanitise",
  "xls": "sanitise",
  "xlsx": "sanitise",
  "mp3": "sanitise",
  "rtf": "sanitise",
  "coff": "sanitise",
  "macho": "sanitise",
  "svg": "sanitise",
  "webp": "sanitise",
  "unknown": "sanitise"
}

Properties

Name	Type	Required	Restrictions	Description
bmp	ContentManagementFlag	false	none	none
doc	ContentManagementFlag	false	none	none
docx	ContentManagementFlag	false	none	none
emf	ContentManagementFlag	false	none	none
gif	ContentManagementFlag	false	none	none
jpg	ContentManagementFlag	false	none	none
wav	ContentManagementFlag	false	none	none
elf	ContentManagementFlag	false	none	none
pe	ContentManagementFlag	false	none	none
mp4	ContentManagementFlag	false	none	none
mpg	ContentManagementFlag	false	none	none
pdf	ContentManagementFlag	false	none	none
png	ContentManagementFlag	false	none	none
ppt	ContentManagementFlag	false	none	none
pptx	ContentManagementFlag	false	none	none
tif	ContentManagementFlag	false	none	none
wmf	ContentManagementFlag	false	none	none
xls	ContentManagementFlag	false	none	none
xlsx	ContentManagementFlag	false	none	none
mp3	ContentManagementFlag	false	none	none
rtf	ContentManagementFlag	false	none	none
coff	ContentManagementFlag	false	none	none
macho	ContentManagementFlag	false	none	none
svg	ContentManagementFlag	false	none	none
webp	ContentManagementFlag	false	none	none
unknown	ContentManagementFlag	false	none	none

ContentManagementFlags

{
  "pdfContentManagement": {
    "acroform": "sanitise",
    "digitalSignatures": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "internalHyperlinks": "sanitise",
    "javascript": "sanitise",
    "metadata": "sanitise",
    "actionsAll": "sanitise",
    "retainExportedStreams": "sanitise",
    "valueOutsideReasonableLimits": "sanitise"
  },
  "wordContentManagement": {
    "dynamicDataExchange": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "hiddenData": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise",
    "trackedChanges": "sanitise"
  },
  "excelContentManagement": {
    "connections": "sanitise",
    "dynamicDataExchange": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "hiddenData": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise",
    "trackedChanges": "sanitise"
  },
  "powerPointContentManagement": {
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "hiddenData": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise",
    "slideNotes": "sanitise"
  },
  "svgConfig": {
    "hyperlinks": "sanitise",
    "foreignObjects": "sanitise",
    "scripts": "sanitise"
  },
  "webpConfig": {
    "metadata": "sanitise"
  },
  "tiffConfig": {
    "geoTiff": "sanitise"
  },
  "archiveConfig": {
    "bmp": "sanitise",
    "doc": "sanitise",
    "docx": "sanitise",
    "emf": "sanitise",
    "gif": "sanitise",
    "jpg": "sanitise",
    "wav": "sanitise",
    "elf": "sanitise",
    "pe": "sanitise",
    "mp4": "sanitise",
    "mpg": "sanitise",
    "pdf": "sanitise",
    "png": "sanitise",
    "ppt": "sanitise",
    "pptx": "sanitise",
    "tif": "sanitise",
    "wmf": "sanitise",
    "xls": "sanitise",
    "xlsx": "sanitise",
    "mp3": "sanitise",
    "rtf": "sanitise",
    "coff": "sanitise",
    "macho": "sanitise",
    "svg": "sanitise",
    "webp": "sanitise",
    "unknown": "sanitise"
  }
}

Properties

Name	Type	Required	Restrictions	Description
pdfContentManagement	PdfContentManagement	true	none	none
wordContentManagement	WordContentManagement	true	none	none
excelContentManagement	ExcelContentManagement	true	none	none
powerPointContentManagement	PowerPointContentManagement	true	none	none
svgConfig	SvgConfig	true	none	none
webpConfig	WebpConfig	true	none	none
tiffConfig	TiffConfig	true	none	none
archiveConfig	ArchiveConfig	true	none	none

PdfSettings

{
  "irregularPdfProcessing": "fast",
  "headerLabel": "",
  "addCautiousOnlyHeaderLabel": false
}

Properties

Name	Type	Required	Restrictions	Description
irregularPdfProcessing	string	true	none	none
headerLabel	string	true	none	none
addCautiousOnlyHeaderLabel	boolean	true	none	none

Enumerated Values

Property	Value
irregularPdfProcessing	fast
irregularPdfProcessing	cautious
irregularPdfProcessing	none

ContentManagementPolicy

{
  "contentManagementFlags": {
    "pdfContentManagement": {
      "acroform": "sanitise",
      "digitalSignatures": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "internalHyperlinks": "sanitise",
      "javascript": "sanitise",
      "metadata": "sanitise",
      "actionsAll": "sanitise",
      "retainExportedStreams": "sanitise",
      "valueOutsideReasonableLimits": "sanitise"
    },
    "wordContentManagement": {
      "dynamicDataExchange": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "hiddenData": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise",
      "trackedChanges": "sanitise"
    },
    "excelContentManagement": {
      "connections": "sanitise",
      "dynamicDataExchange": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "hiddenData": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise",
      "trackedChanges": "sanitise"
    },
    "powerPointContentManagement": {
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "hiddenData": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise",
      "slideNotes": "sanitise"
    },
    "svgConfig": {
      "hyperlinks": "sanitise",
      "foreignObjects": "sanitise",
      "scripts": "sanitise"
    },
    "webpConfig": {
      "metadata": "sanitise"
    },
    "tiffConfig": {
      "geoTiff": "sanitise"
    },
    "archiveConfig": {
      "bmp": "sanitise",
      "doc": "sanitise",
      "docx": "sanitise",
      "emf": "sanitise",
      "gif": "sanitise",
      "jpg": "sanitise",
      "wav": "sanitise",
      "elf": "sanitise",
      "pe": "sanitise",
      "mp4": "sanitise",
      "mpg": "sanitise",
      "pdf": "sanitise",
      "png": "sanitise",
      "ppt": "sanitise",
      "pptx": "sanitise",
      "tif": "sanitise",
      "wmf": "sanitise",
      "xls": "sanitise",
      "xlsx": "sanitise",
      "mp3": "sanitise",
      "rtf": "sanitise",
      "coff": "sanitise",
      "macho": "sanitise",
      "svg": "sanitise",
      "webp": "sanitise",
      "unknown": "sanitise"
    }
  },
  "pdfSettings": {
    "irregularPdfProcessing": "fast",
    "headerLabel": "",
    "addCautiousOnlyHeaderLabel": false
  }
}

Properties

Name	Type	Required	Restrictions	Description
contentManagementFlags	ContentManagementFlags	false	none	none
pdfSettings	PdfSettings	false	none	none

WritePolicyBody

{
  "status": "string",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}

The policy settings to be set for a named policy

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none
policySettings	ContentManagementPolicy	true	none	none

PolicyStatus

"enabled"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	enabled
anonymous	disabled

GetPolicyResponse

{
  "schemaName": "string",
  "policyName": "string",
  "policyIdentity": "string",
  "policyVersion": 0,
  "isDefaultPolicy": true,
  "locks": {
    "property1": {
      "locker": "string",
      "reason": "string"
    },
    "property2": {
      "locker": "string",
      "reason": "string"
    }
  },
  "status": "enabled",
  "schemaReferences": [
    {
      "schemaVersion": "string",
      "property": "string",
      "policyName": "string"
    }
  ],
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "retainExportedStreams": "sanitise",
        "valueOutsideReasonableLimits": "sanitise"
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "trackedChanges": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "hiddenData": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise",
        "slideNotes": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": "sanitise",
        "doc": "sanitise",
        "docx": "sanitise",
        "emf": "sanitise",
        "gif": "sanitise",
        "jpg": "sanitise",
        "wav": "sanitise",
        "elf": "sanitise",
        "pe": "sanitise",
        "mp4": "sanitise",
        "mpg": "sanitise",
        "pdf": "sanitise",
        "png": "sanitise",
        "ppt": "sanitise",
        "pptx": "sanitise",
        "tif": "sanitise",
        "wmf": "sanitise",
        "xls": "sanitise",
        "xlsx": "sanitise",
        "mp3": "sanitise",
        "rtf": "sanitise",
        "coff": "sanitise",
        "macho": "sanitise",
        "svg": "sanitise",
        "webp": "sanitise",
        "unknown": "sanitise"
      }
    },
    "pdfSettings": {
      "irregularPdfProcessing": "fast",
      "headerLabel": "",
      "addCautiousOnlyHeaderLabel": false
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
schemaName	string	false	none	none
policyName	string	false	none	none
policyIdentity	string	false	none	none
policyVersion	integer(int32)	false	none	none
isDefaultPolicy	boolean	false	none	none
locks	object	false	none	none
» additionalProperties	PolicyLock	false	none	none
status	PolicyStatus	false	none	none
schemaReferences	[SchemaReference]	false	none	none
policySettings	ContentManagementPolicy	false	none	none

PolicyLock

{
  "locker": "string",
  "reason": "string"
}

Properties

Name	Type	Required	Restrictions	Description
locker	string	false	none	none
reason	string	false	none	none

SchemaReference

{
  "schemaVersion": "string",
  "property": "string",
  "policyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
schemaVersion	string	false	none	none
property	string	false	none	none
policyName	string	false	none	none

ContentManagementPolicyListItem

{
  "policyName": "default",
  "isDefaultPolicy": true
}

Properties

Name	Type	Required	Restrictions	Description
policyName	string	false	none	none
isDefaultPolicy	boolean	false	none	none

ContentManagementPolicySummary

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/default"
}

Properties

Name	Type	Required	Restrictions	Description
schemaName	string	false	none	none
policyName	string	false	none	none
policyIdentity	string	false	none	none
policyVersion	number	false	none	none
isDefaultPolicy	boolean	false	none	none
status	string	false	none	none
policyLocation	string	false	none	none

WritePolicyBodyResponse

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/default",
  "locks": {
    "property1": {
      "locker": "string",
      "reason": "string"
    },
    "property2": {
      "locker": "string",
      "reason": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
schemaName	string	false	none	none
policyName	string	false	none	none
policyIdentity	string	false	none	none
policyVersion	number	false	none	none
isDefaultPolicy	boolean	false	none	none
status	string	false	none	none
policyLocation	string	false	none	none
locks	object	false	none	none
» additionalProperties	PolicyLock	false	none	none