Get Map Types

Get Map Types

Get all supported map types for the given className and instance.

Request
URI
POST
https://{api_host}/tcsa/api/topology/v1/map-types
COPY
Request Body

Request object to get the map types.

MapTypeRequest of type(s) application/json
Required 
{
    "className": "NetworkFunction",
    "instanceName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES"
}
string
className
Required

The class type of resource.

string
instanceName
Required

Uniquely identifiable instance id.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MaptypeResponse of type(s) application/json 
{
    "default": {
        "displayName": "VRAN Connectivity",
        "name": "MAP-VRAN"
    },
    "mapTypes": [
        {
            "displayName": "VRAN Connectivity",
            "name": "MAP-VRAN"
        },
        {
            "displayName": "5G Core",
            "name": "MAP-5G-CNF"
        }
    ]
}
object
default
Optional

Supported map type for the device type

array of object
mapTypes
Optional

All supporting map types for the device type


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"className:"string","instanceName:"string"}' https://{api_host}/tcsa/api/topology/v1/map-types
On This Page
Topology Operations
POST
Get Class Types
POST
Get Map Types
POST
Get Instances
POST
Get Relationships
POST
Topology Map
POST
Get Domain Managers