Application URL
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.
Listing Application URL Projections and Their Models
List application URL projections and their models that can be requested from the search endpoint.
API Call: GET/client/{clientId}/applicationUrl/model
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/model
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | If you are on platform 1, you do not need to put a number. |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can list application URL projections and their models are:
- Manager
- Group Manager
- User
API Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
cURL
cURL Sample applicationUrl_projections Snippet
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/model"
-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 | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
Response Parameters
Sample Response
{
"subject": "applicationUrl",
"projections": [
{
"name": "basic",
"fields": [
{
"field": "id",
"type": "int",
"nested": []
},
{
"field": "uri",
"type": "string",
"nested": []
},
{
"field": "clientId",
"type": "int",
"nested": []
},
{
"field": "groupId",
"type": "int",
"nested": []
},
{
"field": "applicationId",
"type": "int",
"nested": []
}
]
}
]
}
Name | Description | Additional Information |
---|---|---|
ID | Application URL ID. | integer
|
URI | URI. | string
|
CLIENTID | Client ID number. | integer
|
GROUPID | Group ID number. | integer
|
APPLICATIONID | Application ID number. | integer
|
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
{
"projections": [
{
"name": "basic",
"fields": [
{
"field": "id",
"type": "integer"
},
{
"field": "name",
"type": "string"
}
]
}
]
}
Code | Description |
---|---|
401 | Unauthorized |
404 | Not Found |
Listing Filterable Application URL Fields
Displays the application URL fields that the search endpoint can filter by.
API Call: GET/client/{clientId}/applicationUrl/filter
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/filter
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | If you are on platform 1, you do not need to put a number. |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can list application URL fields that can be filtered by are:
- Manager
- Group Manager
- User
API Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
cURL
cURL Sample list_applicationUrlfields Snippet
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/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 | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
Response Parameters
Sample Response
[
{
"name": "Group Name",
"legacyUid": "group_name",
"uid": "group_name",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": "Filters application URLs by the group name."
},
{
"name": "Id",
"legacyUid": "id",
"uid": "id",
"operators": [
"EXACT",
"IN"
],
"type": "string",
"description": ""
},
{
"name": "URL",
"legacyUid": "url",
"uid": "url",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": "Filters application URLs by the URL."
},
{
"name": "Web Application ID",
"legacyUid": "web_app_id",
"uid": "web_app_id",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": "Filters application URLs by the application ID."
}
]
Name | Description | Additional Information |
---|---|---|
GROUPNAME | UID: group_name | Filter Options: Exact, In, Like, Wildcard |
ID | UID: id | Filter Options: Exact, In |
URL | UID: url | Filter Options: Exact, In, Like, Wildcard |
WEBAPPLICATIONID | UID: web_app_id | Filter Options: Exact, In, Like, Wildcard |
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
[
{
"name": "id",
"uid": "id",
"operator": [
"EXACT",
"IN"
],
"type": "integer",
"description": "The id"
}
]
Code | Description |
---|---|
401 | Unauthorized |
404 | Not Found |
Suggesting Filter Values for Application Unique Finding Filtering
Displays suggested filter values when filtering application URLs.
API Call: POST/client/{clientId}/applicationUrl/suggest
URL: https://platform<#>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/suggest
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
User Roles
The user roles that can view suggested filter values for application URLs are:
- Manager
- Group Manager
- User
API Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
cURL
cURL Sample filter_applicationUrlvalues Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/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>\" }}"
Make sure to replace the angle bracket parameters here with your own values.
cURL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
FIELD | Filter field. | string
|
EXCLUSIVE | Exclusive. | boolean Options: True, False |
OPERATOR | Search operator. | Depends on value. |
VALUE | Search value. | string
|
Response Parameters
Sample Response
[
{
"key": "<KEY>",
"count": <COUNT>
}
]
Name | Description | 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
[
{
"key": "string",
"count": 0
}
]
Code | Description |
---|---|
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
Searching for an Application URL
Search for an assessment URL within the designated client.
API Call: POST/client/{clientId}/applicationUrl/search
URL: https://platform<#>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/search
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
User Roles
The user roles that can search for an application URL are:
- Manager
- Group Manager
- User
API Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
cURL
cURL Sample search_applicationUrl Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/applicationUrl/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>}"
Make sure to replace the option values here with your own option values.
cURL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | |
APIKEY | Your designated API key. | |
PROJECTION | Projection type. | Options: basic, detailed |
SORTFIELD | Field to sort. | |
SORTDIRECTION | Sort direction. | Options: ASC, DESC |
PAGENUMBER | Page number to view. | Note that 0 is the first page. |
PAGESIZE | Number of entries per page. | Shows how many items to display on the page. |
Response Parameters
Sample Response
{
"_embedded": {
"strings": [
{}
]
},
"page": {
"size": <PAGESIZE>,
"totalElements": <TOTALELEMENTS>,
"totalPages": <TOTALPAGES>,
"number": <PAGENUMBER>
},
"errors": [
{
"id": "string",
"errorRefId": "string",
"code": 0,
"cause": "string"
}
]
}
Name | Description | Additional Information |
---|---|---|
PAGESIZE | Page size requested. | Shows how many items to display on the page. |
TOTALELEMENTS | Total elements on pages. | |
TOTALPAGES | Total amount of pages. | |
PAGENUMBER | Page to view. | Note that 0 is the first page. |
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
{
"_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 |