{
"opencollection": "1.0.0",
"info": {
"name": "OpenTextâ„¢ Core Application Security Web API Explorer ApiKeyManagement MobileScans API",
"version": "v3"
},
"items": [
{
"info": {
"name": "MobileScans",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get mobile scan setup details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v3/releases/:releaseId/mobile-scans/scan-setup",
"params": [
{
"name": "releaseId",
"value": "",
"type": "path"
}
]
},
"docs": "Allowed Scopes: api-tenant, start-scans"
},
{
"info": {
"name": "Saves mobile scan setup details",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/api/v3/releases/:releaseId/mobile-scans/scan-setup",
"params": [
{
"name": "releaseId",
"value": "",
"type": "path",
"description": "The release id"
}
]
},
"docs": "Allowed Scopes: api-tenant, start-scans"
},
{
"info": {
"name": "Starts a mobile scan for the given release",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v3/releases/:releaseId/mobile-scans/start-scan",
"params": [
{
"name": "releaseId",
"value": "",
"type": "path",
"description": "The release id"
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "The start date for the scan in MM/dd/yyyy HH:mm format"
},
{
"name": "assessmentTypeId",
"value": "",
"type": "query",
"description": "The assessment type id for the scan
Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types"
},
{
"name": "frameworkType",
"value": "",
"type": "query",
"description": "The framework type id. Only iOS and Android are supported at this time"
},
{
"name": "timeZone",
"value": "",
"type": "query",
"description": "The time zone
Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones"
},
{
"name": "fragNo",
"value": "",
"type": "query",
"description": "-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The offset of the bytes sent. 0 indicates the first bytes"
},
{
"name": "entitlementId",
"value": "",
"type": "query",
"description": "The entitlement id to consume"
},
{
"name": "entitlementFrequencyType",
"value": "",
"type": "query",
"description": "The entitlement frequency type"
},
{
"name": "fileName",
"value": "",
"type": "query",
"description": "The uploaded file name with extension"
},
{
"name": "isRemediationScan",
"value": "",
"type": "query",
"description": "Indicates if the scan is a remediation scan. Value defaults to false if not specified."
},
{
"name": "isBundledAssessment",
"value": "",
"type": "query",
"description": "Indicates if the assessment is a bundled assessment. If not supplied legacy behavior will apply. Value defaults to null if not specified."
},
{
"name": "parentAssessmentTypeId",
"value": "",
"type": "query",
"description": "The parent assessment type id for the bundled assessment. If not supplied legacy behavior will apply"
},
{
"name": "scanMethodType",
"value": "",
"type": "query",
"description": "The method of starting a scan"
},
{
"name": "scanTool",
"value": "",
"type": "query",
"description": "The tool used for scanning"
},
{
"name": "scanToolVersion",
"value": "",
"type": "query",
"description": "The version for the scan tool used for scanning"
}
]
},
"docs": "Allowed Scopes: api-tenant, start-scans"
},
{
"info": {
"name": "Saves the contents to import scan file",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/api/v3/releases/:releaseId/mobile-scans/import-scan",
"params": [
{
"name": "releaseId",
"value": "",
"type": "path",
"description": "Release Id of the scan to import"
},
{
"name": "fragNo",
"value": "",
"type": "query",
"description": "-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The offset of the bytes sent. 0 indicates the first bytes"
},
{
"name": "fileLength",
"value": "",
"type": "query",
"description": "The number of bytes of the file being imported"
},
{
"name": "importScanSessionId",
"value": "",
"type": "query",
"description": "The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id"
}
]
},
"docs": "Allowed Scopes: api-tenant, start-scans"
}
]
}
],
"bundled": true
}