Assessment

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

The Ivanti Neurons for RBVM/ASOC platform lets users perform periodic evaluations or assessments of the vulnerabilities affecting an organization’s network assets and applications. This provides organizations with a detailed “point in time” measure of an organization’s security and risk posture. These assessments also allow an organization to track and compare current performance against previous evaluations of vulnerabilities and risk, as well as provide a measure of the effectiveness of remediation or mitigation efforts.

Creating an Assessment

Create an assessment for the designated client.

API Call: POST/client/{clientId}/assessment

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privilege required to create an assessment is:

  • Assessment Control

Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
ASSESSMENTNAME Assessment name. string Y
STARTDATE Assessment start date. string($date) Y Format: YYYY-MM-DD.
NOTES Assessment notes. string Y

cURL

cURL Sample create_assessment Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>" \
  -H  "Content-Type: application/json" \
  -d "{  \"name\": \"<ASSESSMENTNAME>\",  \"startDate\": \"<STARTDATE>\",  \"notes\": \"<NOTES>\"}"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
ASSESSMENTNAME Assessment name. string Y
STARTDATE Assessment start date. string($date) Y Format: YYYY-MM-DD.
NOTES Assessment notes. string N

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "name": "<NAME>",
  "notes": "<NOTES>",
  "clientId": <CLIENTID>,
  "startDate": "<STARTDATE>"
}

Name Description Type Additional Information
ID Assessment ID number. integer
NAME Assessment name. string
STARTDATE Assessment start date. string($date) Format: YYYY-MM-DD.
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

Copy 

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}

Code Description
400 User Error

400 Sample Response

Copy 

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Code Description
401 Unauthorized
404 Not Found

Updating an Assessment

Update an assessment for the designated client. Replaces all fields in the assessment with the new values.

API Call: PUT/client/{clientId}/assessment/{assessmentId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ASSESSMENTID Assessment ID number. Searching for an Assessment

Required Privileges

The privilege required to update an assessment is:

  • Assessment Control

Python

Python Sample update_assessment Snippet

Copy 

import json
import requests

platform = 'http://platform<PLATFORM>.risksense.com'
client_id = <CLIENTID>
api_key = "<APIKEY>"
assessment_id = <ASSESSMENTID>

name = "<ASSESSMENTNAME>"
start_date = "<STARTDATE>"
notes = "<NOTES>"

url = platform + "/api/v1/client/" + str(client_id) + "/assessment/" + str(assessment_id)

header = {
    "x-api-key": api_key,
    "Content-Type": "application/json",
    "Cache-Control": "no-cache"
}

body = {
    "name": name,
    "startDate": start_date,
    "notes": notes
}

response = requests.put(url, headers=header, data=json.dumps(body))

Replace angle bracket parameters with your own values.

Python Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
ASSESSMENTNAME Assessment name. string Y
STARTDATE Assessment start date. string($date) Y Format: YYYY-MM-DD.
NOTES Assessment notes. string Y

cURL

cURL Sample update_assessment Snippet

Copy 

curl -X PUT "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>" \
  -H  "accept: application/json"  \
  -H  "x-api-key: <APIKEY>"  \
  -H  "Content-Type: application/json"  \
  -d "{  \"name\": \"<ASSESSMENTNAME>\",  \"startDate\": \"<STARTDATE>\",  \"notes\": \"<NOTES>\"}"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
APIKEY Your API key. string Y Generating an API Token
ASSESSMENTNAME Assessment name. string N
STARTDATE Assessment start date. string($date) N Format: YYYY-MM-DD.
NOTES Assessment notes. string N

Response Parameters

Sample Response

Copy 

{
  "id": <ASSESSMENTID>,
  "clientId": <CLIENTID>
  "name": "<ASSESSMENTNAME>",
  "notes": "<NOTES>",
  "startDate": "<STARTDATE>"
}

Name Description Type Additional Information
ASSESSMENTID Assessment ID number. integer
CLIENTID Client ID number. integer
ASSESSMENTNAME Assessment name. string
NOTES Assessment notes. string
STARTDATE Assessment start date. string($date) Format: YYYY-MM-DD.

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 

{
  "id": 12,
  "clientId": 5
  "name": "Q3",
  "notes": "Updated assessment",
  "startDate": "2020-04-01"
}

Code Description
400 User Error

400 Sample Response

Copy 

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Code Description
401 Unauthorized
404 Not Found

Deleting an Assessment

Delete an assessment for the designated client.

API Call: DELETE/client/{clientId}/assessment/{assessmentId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ASSESSMENTID Assessment ID number. Searching for an Assessment

Required Privileges

The privileges required to delete an assessment are:

  • Assessment Control

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment

cURL

cURL Sample delete_assessment Snippet

Copy 

curl -X DELETE "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Type Additional Information
ID Job ID number. integer
CREATED Time/date when job was created. string($date-time)

HTTP Status Codes

Code Description
200 Job Created

200 Sample Response

Copy 

{
  "id": 0,
  "created": "2019-02-12T22:51:53.206Z"
}

Code Description
401 Unauthorized
404 Not Found

Listing Assessment Projections and Their Models

List assessment projections and their models that can be requested from the search endpoint.

API Call: GET/client/{clientId}/assessment/model

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/model

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to list assessment projections and their models is:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

cURL

cURL Sample assessment_projections Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/model" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 
{
  "subject": "assessment",
  "projections": [
    {
      "name": "basic",
      "fields": [
        {
          "field": "id",
          "type": "int",
          "nested": []
        },
        {
          "field": "clientId",
          "type": "int",
          "nested": []
        },
        {
          "field": "name",
          "type": "string",
          "nested": []
        },
        {
          "field": "notes",
          "type": "string",
          "nested": []
        },
        {
          "field": "startDate",
          "type": "string",
          "nested": []
        },
        {
          "field": "fileCount",
          "type": "int",
          "nested": []
        },
        {
          "field": "hostsScanned",
          "type": "int",
          "nested": []
        },
        {
          "field": "applicationsScanned",
          "type": "int",
          "nested": []
        }
      ]
    },
    {
      "name": "detail",
      "fields": [
        {
          "field": "id",
          "type": "int",
          "nested": []
        },
        {
          "field": "clientId",
          "type": "int",
          "nested": []
        },
        {
          "field": "name",
          "type": "string",
          "nested": []
        },
        {
          "field": "notes",
          "type": "string",
          "nested": []
        },
        {
          "field": "startDate",
          "type": "string",
          "nested": []
        },
        {
          "field": "files",
          "type": "AssessmentFile",
          "nested": [
            {
              "field": "uuid",
              "type": "string",
              "nested": []
            },
            {
              "field": "name",
              "type": "string",
              "nested": []
            },
            {
              "field": "id",
              "type": "Object",
              "nested": []
            }
          ]
        },
        {
          "field": "hostsScanned",
          "type": "int",
          "nested": []
        },
        {
          "field": "applicationsScanned",
          "type": "int",
          "nested": []
        }
      ]
    }
  ]
}
Name Description Type Additional Information
ID Assessment ID number. integer
CLIENTID Client ID number. integer
NAME Assessment name. string
NOTES Notes about the assessment. string
STARTDATE Assessment start date. string
FILECOUNT Number of files on assessment. integer
HOSTSSCANNED Number of hosts scanned. integer
APPLICATIONSSCANNED Number of applications scanned. integer
UUID Assessment File Universal Unique Identifier. string
NAME Assessment file name. string
ID Assessment file ID. object

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
{
  "projections": [
    {
      "name": "basic",
      "fields": [
        {
          "field": "id",
          "type": "integer"
        },
        {
          "field": "name",
          "type": "string"
        }
      ]
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Listing Filterable Assessment Fields

Displays the filterable assessment fields that can be used by the search endpoint.

API Call: GET/client/{clientId}/assessment/filter

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/filter

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to list filterable assessment fields is:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample list_assessmentfields Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/filter"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 

[
  {
    "name": "Date Started",
    "legacyUid": "date",
    "uid": "startDate",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "date",
    "description": ""
  },
  {
    "name": "Id",
    "legacyUid": "id",
    "uid": "id",
    "operators": [
      "EXACT",
      "IN"
    ],
    "type": "string",
    "description": ""
  },
  {
    "name": "Is Complete",
    "legacyUid": "is_complete",
    "uid": "is_complete",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": ""
  },
  {
    "name": "Name",
    "legacyUid": "label",
    "uid": "name",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": ""
  }
]

Name Description Type Additional Information
DATESTARTED Assessment Start Date. date Filter Options: Exact, In, Range
ID Assessment ID number. string Filter Options: Exact, In
ISCOMPLETE Is the assessment complete? boolean Filter Options: Exact
NAME Assessment name. string Filter Options: Exact, In, Like, Wildcard

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
[
  {
    "name": "id",
    "uid": "id",
    "operator": [
      "EXACT",
      "IN"
    ],
    "type": "integer",
    "description": "The id"
  }
]
Code Description
401 Unauthorized
404 Not Found

Suggesting Filter Values for Assessment Filtering

Displays suggested filter values when filtering assessments.

API Call: POST/client/{clientId}/assessment/suggest

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/suggest

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can view suggested filter values for assessments are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
FIELD Filter category. string Y
EXCLUSIVE Exclusive. boolean Y Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field.
OPERATOR Search operator. string Y Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR
VALUE Search value. string Y

cURL

cURL Sample filter_assessmentvalues Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/suggest" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>" \
  -H  "Content-Type: application/json" \
  -d "{  \"filters\": [    {      \"field\": \"<FIELD>\",      \"exclusive\": <EXCLUSIVE>,      \"operator\": \"<OPERATOR>\",      \"value\": \"<VALUE>\"    }  ],  \"filter\": {    \"field\": \"<FIELD>\",    \"exclusive\": <EXCLUSIVE>,    \"operator\": \"<OPERATOR>\",    \"value\": \"<VALUE>\"  }}"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
FIELD Filter category. string Y
EXCLUSIVE Exclusive. boolean Y Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field.
OPERATOR Search operator. string Y Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR
VALUE Search value. string Y

Response Parameters

Sample Response

Copy 

[
  {
    "key": "<KEY>",
    "count": <COUNT>
  }
]

Name Description Type Additional Information
KEY Value for the field the suggestion was requested for. string
COUNT Count. integer($int64)

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
[
  {
    "key": "string",
    "count": 0
  }
]
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Searching for an Assessment

Search for an assessment within the designated client.

API Call: POST/client/{clientId}/assessment/search

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/search

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can search for an assessment are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
FIELD Filter category. string N
EXCLUSIVE Exclusive. boolean N Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field.
OPERATOR Search operator. string N Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR
VALUE Search value. string N
PROJECTION Projection type. string Y Options: basic, detailed
SORTFIELD Field to sort by. string Y
SORTDIRECTION Sort direction. string Y Options: ASC, DESC
PAGENUMBER Page to view. integer Y First Page: 0
PAGESIZE Page size requested. integer Y Shows how many items to display on the page.

cURL

cURL Sample search_assessment Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/search" \
  -H "accept: application/json" \
  -H "x-api-key: <APIKEY>" \
  -H "Content-Type: application/json" \
  -d "{ \"projection\": \"<PROJECTION>\", \"sort\": [ { \"field\": \"<SORTFIELD>\", \"direction\": \"<SORTDIRECTION>\" } ], \"page\": <PAGENUMBER>, \"size\": <PAGESIZE>}"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
PROJECTION Projection type. string Y Options: basic, detailed
SORTFIELD Field to sort by. string Y
SORTDIRECTION Sort direction. string Y Options: ASC, DESC
PAGENUMBER Page to view. integer Y First Page: 0
PAGESIZE Page size requested. integer Y Shows how many items to display on the page.

Response Parameters

Sample Response

Copy 

{
  "errors": [],
  "page": {
    "size": <PAGESIZE>,
    "totalElements": <TOTALELEMENTS>,
    "totalPages": <TOTALPAGES>,
    "number": <PAGENUMBER>
  },
  "_links": {
    "self": {
      "href": "http://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/search?page=<PAGENUMBER>&size=<PAGESIZE>&sort=<SORTFIELD>,<SORTDIRECTION>"
    }
  }
}

Name Description Type Additional Information
PAGESIZE Page size requested. integer Shows how many items to display on the page.
TOTALELEMENTS Total number of items available. integer
TOTALPAGES Total number of pages available. integer
PAGENUMBER Page to view. integer First Page: 0
PLATFORM Platform number. integer
CLIENTID Client ID number. integer
PAGESIZE Page size requested. integer Shows how many items to display on the page.
SORTFIELD Field to sort by. string
SORTDIRECTION Sort direction. string Options: ASC, DESC

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "_embedded": {
    "strings": [
      {}
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  },
  "errors": [
    {
      "id": "string",
      "errorRefId": "string",
      "code": 0,
      "cause": "string"
    }
  ]
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Listing an Assessment's Attachments

List files attached to an assessment.

API Call: GET/client/{clientId}/assessment/{assessmentId}/attachment

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ASSESSMENTID Assessment ID number. Searching for an Assessment

User Roles

The user roles that can list files attached to an assessment are:

  • Manager
  • Group Manager

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
APIKEY Your API key. string Y Generating an API Token

cURL

cURL Sample assessment_attachments Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 

[
  {
    "uuid": "<UUID>",
    "filename": "<FILENAME>",
    "contentType": "<CONTENTTYPE>",
    "contentLength": <CONTENTLENGTH>
  }
]

Name Description Type Additional Information
UUID Attachment Universal Unique Identifier. string
FILENAME Attachment file name. string
CONTENTTYPE Attachment content type. string
CONTENTLENGTH Attachment content length. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
[
  {
    "filename": "string",
    "uuid": "string",
    "contentType": "string",
    "contentLength": 0
  }
]
Code Description
401 Unauthorized
404 Not Found

Fetching an Assessment's Attachment by UUID

Fetch an assessment's attachment by the attachment's UUID.

API Call: GET/client/{clientId}/assessment/{assessmentId}/attachment/{attachmentUUID}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment/<ATTACHMENTUUID>

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ASSESSMENTID Assessment ID number. Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. Listing an Assessment's Attachments

User Roles

The user roles that can fetch an assessment's attachment by UUID are:

  • Manager
  • Group Manager

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. string Y Listing an Assessment's Attachments
APIKEY Your API key. string Y Generating an API Token

cURL

cURL Sample fetch_attachmentsuuid Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment/<ATTACHMENTUUID>" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. string Y Listing an Assessment's Attachments
APIKEY Your API key. string Y Generating an API Token

Response Parameters

The uploaded file for this example is a Notepad attachment with the text "This is a test." in the body.

Sample Response

Copy 

This is a test.

HTTP Status Codes

Code Description
200 Success
401 Unauthorized
404 Not Found
406 MIME Mismatch

For the MIME mismatch, try changing from application/octet-stream to application/json or vice versa.

Fetching an Assessment's Attachment's Metadata

Fetch an assessment's attachment's metadata.

API Call: GET/client/{clientId}/assessment/{assessmentId}/attachment/{attachmentUUID}/meta

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment/<ATTACHMENTUUID>/meta

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ASSESSMENTID Assessment ID number. Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. Listing an Assessment's Attachments

User Roles

The user roles that can fetch an assessment's attachment's metadata are:

  • Manager
  • Group Manager

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. string Y Listing an Assessment's Attachments
APIKEY Your API key. string Y Generating an API Token

cURL

cURL Sample fetch_attachmentsmetadata Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/assessment/<ASSESSMENTID>/attachment/<ATTACHMENTUUID>/meta" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
ASSESSMENTID Assessment ID number. integer Y Searching for an Assessment
ATTACHMENTUUID Attachment UUID number. string Y Listing an Assessment's Attachments
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 

{
  "uuid": "<UUID>",
  "filename": "<FILENAME>",
  "contentType": "<CONTENTTYPE>",
  "contentLength": <CONTENTLENGTH>
}

Name Description Type Additional Information
UUID Attachment Universal Unique Identifier. string
FILENAME Attachment file name. string
CONTENTTYPE Attachment content type. string
CONTENTLENGTH Attachment content length. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "filename": "string",
  "uuid": "string",
  "contentType": "string",
  "contentLength": 0
}

401 | Unauthorized 404 | Not Found