Return the link definition from the user-defined link type. If
linkType
is not specified, all link definitions are
returned.
API method:
GET
/v1/getUserDefinedLink
Examples
(1) If
linkType
is specified
Input:
{
"linkType" : "UniqueLinkTypeName"
}
Output:
[
{
"linkType" : "UniqueLinkTypeName",
"displayName" : "My Link Type",
"description" : null,
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP4Ranged", "IP4Block"]
}
]
Output (with description specified):
[
{
"linkType" : "UniqueLinkTypeName",
"displayName" : "My Link Type",
"description" : "My Link Type description",
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP4Ranged", "IP4Block"]
}
]
(2) If linkType
is not specified
Input:
"linkType" : ""
Output:
[
{
"linkType" : "UniqueLinkType",
"displayName" : "My Link Type",
"description" : null,
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP4Ranged", "IP4Block"]
},
{
"linkType" : "UniqueLinkType2",
"displayName" : "Your Link Type",
"description" : null,
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP6Ranged", "IP6Network"]
},
...
]
[
{
"linkType" : "UniqueLinkType",
"displayName" : "My Link Type",
"description" : "My Link Type description",
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP4Ranged", "IP4Block"]
},
{
"linkType" : "UniqueLinkType2",
"displayName" : "Your Link Type",
"description" : "My Link Type description2",
"sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
"destinationEntityTypes" : ["IP6Ranged", "IP6Network"]
},
...
]
Parameters
linkType
—enter a unique name for the user-defined link.Note:- You cannot enter a name that is a reserved link type name. For a list of reserved link type names, refer to Reference: Reserved link type names.
- You cannot enter a name that begins with the prefix "BCN_".
- You must enter a defined user-defined link.