Scan Results API v1

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

Describes the API calls used to retrieve the results of Constellations scans.

Base URLs:

• /api/v1

Authentication

• HTTP Authentication, scheme: bearer

ScanResults

Retrieve the CDR result for a given scan

Code samples

# You can also use wget
curl -X GET /api/v1/scan-results/{scanId}/summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scan-results/{scanId}/summary HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scan-results/{scanId}/summary',
{
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scan-results/{scanId}/summary',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scan-results/{scanId}/summary', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/scan-results/{scanId}/summary', 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/scan-results/{scanId}/summary");
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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

GET /scan-results/{scanId}/summary

The response provides a summary of the CDR processing that has been carried out on the scanned files.

Requests submitted with the ‘StandardUser’ role are only permitted to retrieve self-started scans.

Parameters

Example responses

200 Response

{
  "scanDetails": {
    "scanOwner": "string",
    "scanId": "fda3f490-eac1-4267-a13b-69d14aceb1f0",
    "scanStatus": "Processing",
    "scanStartTime": "2019-08-24T14:15:22Z",
    "scanEndTime": "2019-08-24T14:15:22Z",
    "sourceStorage": "scan-source.blob.core.windows.net",
    "sourceContainerPath": "SourceContainer",
    "targetStorage": "output-location.blob.core.windows.net",
    "targetContainerPath": "TargetContainerName",
    "quarantineContainerPath": "QuarantineContainerName",
    "autoRescan": true,
    "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
    "childScans": null
  },
  "processingResults": {
    "numberOfFiles": 0,
    "numberOfProcessedFiles": 0,
    "numberOfFailedFiles": 0,
    "numberOfRebuiltFiles": 0,
    "numberOfErroredFiles": 0
  }
}

Responses

Response Headers

Retrieve the status of each file processed by CDR engine for a given scan

Code samples

# You can also use wget
curl -X GET /api/v1/scan-results/{scanId}/files \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scan-results/{scanId}/files HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scan-results/{scanId}/files',
{
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scan-results/{scanId}/files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scan-results/{scanId}/files', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/scan-results/{scanId}/files', 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/scan-results/{scanId}/files");
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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

GET /scan-results/{scanId}/files

The response provides the status of each file that was processed by the CDR Engine for a given scan along with the file metadata.

Requests submitted with the ‘StandardUser’ role are only permitted to retrieve self-started scans.

Parameters

Detailed descriptions

pageSize: Limits the number of records returned in the response.

page: Identifies which page in the results is returned. If the value exceeds the number of available pages, then the last page is returned. required: false

includeRebuilt: Indicates whether the details of files that have been rebuilt should be included in the returned results

Example responses

200 Response

{
  "scanDetails": {
    "scanOwner": "string",
    "scanId": "fda3f490-eac1-4267-a13b-69d14aceb1f0",
    "scanStatus": "Processing",
    "scanStartTime": "2019-08-24T14:15:22Z",
    "scanEndTime": "2019-08-24T14:15:22Z",
    "sourceStorage": "scan-source.blob.core.windows.net",
    "sourceContainerPath": "SourceContainer",
    "targetStorage": "output-location.blob.core.windows.net",
    "targetContainerPath": "TargetContainerName",
    "quarantineContainerPath": "QuarantineContainerName",
    "autoRescan": true,
    "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
    "childScans": null
  },
  "scanFiles": [
    {
      "fileLocation": "supported/1/test.png",
      "fileSize": 123456,
      "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "hashingAlgorithm": "SHA256",
      "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
      "status": "Failed"
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=3",
    "next": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=4",
    "prev": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=2"
  }
}

Responses

Response Headers

Retrieve detailed CDR results for a given file in a given scan

Code samples

# You can also use wget
curl -X GET /api/v1/scan-results/{scanId}/files/{fileId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scan-results/{scanId}/files/{fileId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scan-results/{scanId}/files/{fileId}',
{
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scan-results/{scanId}/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scan-results/{scanId}/files/{fileId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/scan-results/{scanId}/files/{fileId}', 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/scan-results/{scanId}/files/{fileId}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scan-results/{scanId}/files/{fileId}", data)
    req.Header = headers

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

GET /scan-results/{scanId}/files/{fileId}

The response contains the detailed CDR results for a given file in a given scan if the file is not an archive.

The response structure varies for the archive file based on the archive mode. There are 2 archive modes that can be configured for the product which are “basic” and “detailed”.

If the archive mode was configured as “basic” during the scan processing, then this endpoint will report the CDR result of the archive file without expanding the files within the archive. Refer schema, “ScanStatusFileResults”.

If the archive mode was configured as “detailed” during the scan processing, then this endpoint will report the CDR results of the individual files within the archive file. Refer schema, “ScanStatusArchiveResults”

Requests submitted with the ‘StandardUser’ role are only permitted to retrieve self-started scans.

Parameters

Example responses

CDR Detailed Results for the specified scan and file

{
  "fileDetails": {
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "rebuiltFileHash": "null",
    "hashingAlgorithm": "SHA256",
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "status": "Failed",
    "remedyItems": [
      {
        "technicalDescription": "Object specified as free in original will be removed",
        "remedyId": 198311939,
        "instanceCount": 3
      }
    ],
    "sanitisationItems": [
      {
        "technicalDescription": "Action of type /URI removed by content management policy.",
        "sanitisationId": 346815988,
        "instanceCount": 2
      }
    ],
    "issueItems": [
      {
        "technicalDescription": "Validation of this MTEF Version not supported",
        "issueId": 289311464,
        "instanceCount": 1,
        "riskLevel": "Medium"
      }
    ],
    "errors": [
      {
        "errorCode": 12,
        "errorDescription": "Invalid Content Management Policy"
      }
    ]
  }
}

{
  "fileDetails": {
    "fileLocation": "supported/1/test.zip",
    "fileSize": 123456,
    "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "rebuiltFileHash": "null",
    "hashingAlgorithm": "SHA256",
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "archiveList": [
      {
        "fileLocation": "supported/1/test1.png",
        "fileSize": 123456,
        "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
        "status": "Failed"
      },
      {
        "fileLocation": "supported/1/test2.pdf",
        "fileSize": 123456,
        "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
        "status": "Failed"
      }
    ]
  },
  "pageLinks": {
    "totalPages": 6,
    "curr": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=3",
    "next": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=4",
    "prev": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=2"
  }
}

Responses

Response Schema

Enumerated Values

Response Headers

Retrieve the detailed CDR results for a given file within an archive for a given scan. Detailed archive mode is required.

Code samples

# You can also use wget
curl -X GET /api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}',
{
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}', 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/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scan-results/{scanId}/files/{fileId}/content/{archiveContentId}", data)
    req.Header = headers

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

GET /scan-results/{scanId}/files/{fileId}/content/{archiveContentId}

This endpoint is applicable only if the archive mode is set to “detailed”.

The response provides the CDR analysis results for a given file within the archive. {fileId} corresponds to the fileId of the archive and {archiveContentId} corresponds to the fileId of the file within the archive.

Requests submitted with the ‘StandardUser’ role are only permitted to retrieve self-started scans.

Parameters

Example responses

200 Response

{
  "fileDetails": {
    "archiveId": "lk09f362-6c83-49a1-bbcb-7c08389a0mnb",
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "status": "Failed",
    "remedyItems": [
      {
        "technicalDescription": "Object specified as free in original will be removed",
        "remedyId": 198311939,
        "instanceCount": 3
      }
    ],
    "sanitisationItems": [
      {
        "technicalDescription": "Action of type /URI removed by content management policy.",
        "sanitisationId": 346815988,
        "instanceCount": 2
      }
    ],
    "issueItems": [
      {
        "technicalDescription": "Validation of this MTEF Version not supported",
        "issueId": 289311464,
        "instanceCount": 1,
        "riskLevel": "Medium"
      }
    ],
    "errors": [
      {
        "errorCode": 12,
        "errorDescription": "Invalid Content Management Policy"
      }
    ]
  }
}

Responses

Response Headers

Retrieve the filetype information for a given scan

Code samples

# You can also use wget
curl -X GET /api/v1/scan-results/{scanId}/files-format \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scan-results/{scanId}/files-format HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scan-results/{scanId}/files-format',
{
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scan-results/{scanId}/files-format',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scan-results/{scanId}/files-format', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/scan-results/{scanId}/files-format', 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/scan-results/{scanId}/files-format");
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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scan-results/{scanId}/files-format", data)
    req.Header = headers

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

GET /scan-results/{scanId}/files-format

The response provides the counts on the different filetypes that are recognized by Glasswall CDR Engine during the scan.

Requests submitted with the ‘StandardUser’ role are only permitted to retrieve self-started scans.

Parameters

Example responses

200 Response

{
  "pdfCount": 0,
  "excelCount": 0,
  "powerpointCount": 0,
  "wordCount": 0,
  "mediaCount": 0,
  "imagesCount": 0,
  "archiveCount": 0,
  "metafilesCount": 0,
  "executableCount": 0,
  "unrecognizedCount": 0
}

Responses

Response Headers

Schemas

ScanStatusItem

{
  "scanOwner": "string",
  "scanId": "fda3f490-eac1-4267-a13b-69d14aceb1f0",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Properties

Enumerated Values

ScanStatusSummary

{
  "scanDetails": {
    "scanOwner": "string",
    "scanId": "fda3f490-eac1-4267-a13b-69d14aceb1f0",
    "scanStatus": "Processing",
    "scanStartTime": "2019-08-24T14:15:22Z",
    "scanEndTime": "2019-08-24T14:15:22Z",
    "sourceStorage": "scan-source.blob.core.windows.net",
    "sourceContainerPath": "SourceContainer",
    "targetStorage": "output-location.blob.core.windows.net",
    "targetContainerPath": "TargetContainerName",
    "quarantineContainerPath": "QuarantineContainerName",
    "autoRescan": true,
    "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
    "childScans": null
  },
  "processingResults": {
    "numberOfFiles": 0,
    "numberOfProcessedFiles": 0,
    "numberOfFailedFiles": 0,
    "numberOfRebuiltFiles": 0,
    "numberOfErroredFiles": 0
  }
}

Properties

ProcessingSummaryItem

{
  "numberOfFiles": 0,
  "numberOfProcessedFiles": 0,
  "numberOfFailedFiles": 0,
  "numberOfRebuiltFiles": 0,
  "numberOfErroredFiles": 0
}

Properties

ScanStatusResults

{
  "scanDetails": {
    "scanOwner": "string",
    "scanId": "fda3f490-eac1-4267-a13b-69d14aceb1f0",
    "scanStatus": "Processing",
    "scanStartTime": "2019-08-24T14:15:22Z",
    "scanEndTime": "2019-08-24T14:15:22Z",
    "sourceStorage": "scan-source.blob.core.windows.net",
    "sourceContainerPath": "SourceContainer",
    "targetStorage": "output-location.blob.core.windows.net",
    "targetContainerPath": "TargetContainerName",
    "quarantineContainerPath": "QuarantineContainerName",
    "autoRescan": true,
    "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
    "childScans": null
  },
  "scanFiles": [
    {
      "fileLocation": "supported/1/test.png",
      "fileSize": 123456,
      "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "hashingAlgorithm": "SHA256",
      "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
      "status": "Failed"
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=3",
    "next": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=4",
    "prev": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=2"
  }
}

Properties

ScanStatusFileResults

{
  "fileDetails": {
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "hashingAlgorithm": "SHA256",
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "status": "Failed",
    "remedyItems": [
      {
        "technicalDescription": "Object specified as free in original will be removed",
        "remedyId": 198311939,
        "instanceCount": 3
      }
    ],
    "sanitisationItems": [
      {
        "technicalDescription": "Action of type /URI removed by content management policy.",
        "sanitisationId": 346815988,
        "instanceCount": 2
      }
    ],
    "issueItems": [
      {
        "technicalDescription": "Validation of this MTEF Version not supported",
        "issueId": 289311464,
        "instanceCount": 1,
        "riskLevel": "Medium"
      }
    ],
    "errors": [
      {
        "errorCode": 12,
        "errorDescription": "Invalid Content Management Policy"
      }
    ]
  }
}

Properties

ScanStatusArchiveResults

{
  "fileDetails": {
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "hashingAlgorithm": "SHA256",
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "status": "Failed",
    "archiveList": [
      {
        "fileLocation": "supported/1/test.png",
        "fileSize": 123456,
        "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
        "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
        "hashingAlgorithm": "SHA256",
        "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
        "status": "Failed"
      }
    ]
  },
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=3",
    "next": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=4",
    "prev": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=2"
  }
}

Properties

ScanStatusArchiveResultsDetailed

{
  "fileDetails": {
    "archiveId": "lk09f362-6c83-49a1-bbcb-7c08389a0mnb",
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
  },
  "processingResults": {
    "status": "Failed",
    "remedyItems": [
      {
        "technicalDescription": "Object specified as free in original will be removed",
        "remedyId": 198311939,
        "instanceCount": 3
      }
    ],
    "sanitisationItems": [
      {
        "technicalDescription": "Action of type /URI removed by content management policy.",
        "sanitisationId": 346815988,
        "instanceCount": 2
      }
    ],
    "issueItems": [
      {
        "technicalDescription": "Validation of this MTEF Version not supported",
        "issueId": 289311464,
        "instanceCount": 1,
        "riskLevel": "Medium"
      }
    ],
    "errors": [
      {
        "errorCode": 12,
        "errorDescription": "Invalid Content Management Policy"
      }
    ]
  }
}

Properties

ScanResultsLinks

{
  "totalPages": 4,
  "curr": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
  "next": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
  "prev": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

ScanResultsLinksAllUsers

{
  "totalPages": 4,
  "curr": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
  "next": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
  "prev": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

PageLinksForFiles

{
  "totalPages": 4,
  "curr": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=3",
  "next": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=4",
  "prev": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

PageLinksForArchives

{
  "totalPages": 4,
  "curr": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=3",
  "next": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=4",
  "prev": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

ScanFilesItemList

[
  {
    "fileLocation": "supported/1/test.png",
    "fileSize": 123456,
    "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    "hashingAlgorithm": "SHA256",
    "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
    "status": "Failed"
  }
]

Properties

ScanFilesAssessmentArchiveList

{
  "status": "Failed",
  "archiveList": [
    {
      "fileLocation": "supported/1/test.png",
      "fileSize": 123456,
      "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
      "hashingAlgorithm": "SHA256",
      "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
      "status": "Failed"
    }
  ]
}

Properties

ScanFilesAssessmentMetadata

{
  "fileLocation": "supported/1/test.png",
  "fileSize": 123456,
  "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
  "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
  "hashingAlgorithm": "SHA256",
  "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
  "status": "Failed"
}

Properties

Enumerated Values

ScanFileMetadata

{
  "fileLocation": "supported/1/test.png",
  "fileSize": 123456,
  "sourceFileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
  "rebuiltFileHash": "r6hWfYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
  "hashingAlgorithm": "SHA256",
  "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
}

Properties

ScanArchiveFileMetadata

{
  "archiveId": "lk09f362-6c83-49a1-bbcb-7c08389a0mnb",
  "fileLocation": "supported/1/test.png",
  "fileSize": 123456,
  "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa"
}

Properties

ScanFilesAssessmentProcessingResults

{
  "status": "Failed",
  "remedyItems": [
    {
      "technicalDescription": "Object specified as free in original will be removed",
      "remedyId": 198311939,
      "instanceCount": 3
    }
  ],
  "sanitisationItems": [
    {
      "technicalDescription": "Action of type /URI removed by content management policy.",
      "sanitisationId": 346815988,
      "instanceCount": 2
    }
  ],
  "issueItems": [
    {
      "technicalDescription": "Validation of this MTEF Version not supported",
      "issueId": 289311464,
      "instanceCount": 1,
      "riskLevel": "Medium"
    }
  ],
  "errors": [
    {
      "errorCode": 12,
      "errorDescription": "Invalid Content Management Policy"
    }
  ]
}

Properties

ScanFileFormatResults

{
  "pdfCount": 0,
  "excelCount": 0,
  "powerpointCount": 0,
  "wordCount": 0,
  "mediaCount": 0,
  "imagesCount": 0,
  "archiveCount": 0,
  "metafilesCount": 0,
  "executableCount": 0,
  "unrecognizedCount": 0
}

Properties

ErrorResponseList

[
  {
    "errorCode": 105,
    "errorDescription": "The signed start (se) parameter must be in the future for the source connection string."
  }
]

List of errors found during validation

Properties