Get Application Map

Get Application Map

[OPERATOR ONLY] Fetch application map resource

Request
URI
GET
https://{api_host}/api/sdwan/v2/applicationMaps/{logicalId}
COPY
Path Parameters
string
logicalId
Required

The logicalId GUID for the target resource

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

Responses
200

Request successfully processed

Returns ApplicationMapResource of type(s) application/json 
{
    "_href": "string",
    "created": "string",
    "name": "string",
    "logicalId": "string",
    "type": "string",
    "description": "string",
    "version": "string",
    "manifest": {},
    "modified": "string",
    "fileName": "string",
    "uploadDetails": {},
    "timestamp": "string",
    "downloadToken": "string",
    "downloadUrl": "string",
    "blobContent": {
        "applications": [
            {
                "_href": "string",
                "name": "string",
                "displayName": "string",
                "class": 0,
                "description": "string",
                "knownIpPortMapping": {},
                "protocolPortMapping": {},
                "mustNotPerformDpi": 0
            }
        ]
    }
}
string
_href
Optional

_href

string As date-time As date-time
created
Optional

created

string
name
Optional

name

string
logicalId
Optional

logicalId

string
type
Optional

type

string
description
Optional

description

string
version
Optional

version

JSONObject
manifest
Optional

manifest

string As date-time As date-time
modified
Optional

modified

string
fileName
Optional

fileName

JSONObject
uploadDetails
Optional

uploadDetails

string As date-time As date-time
timestamp
Optional

timestamp

string
downloadToken
Optional

downloadToken

string
downloadUrl
Optional

downloadUrl

ApplicationMapResourceBlobContent
blobContent
Optional

blobContent


401

Unauthorized

Returns UnAuthorized of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


On This Page
Monitor Operations
GET
Get Application Map
GET
Get Application Map Application
GET
Get Application Map Application Classes
GET
Get Application Map Applications