Create a new Profile .
post
/profile
Create a new Profile .
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Profile object to be created.
Root Schema : schema
Type:
Show Source
object
-
alarmSummary: object
AlarmSummary
-
businessObjectClass: string
-
createdDate: string
(date)
-
createdUser: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
id: string
-
json: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
name: string
-
profileEdges: array
profileEdges
-
profileVertices: array
profileVertices
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
referenceId: integer
(int64)
-
refresh: boolean
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
status: string
-
zoomLevel: integer
(int32)
Nested Schema : ProfileEdge
Type:
Show Source
object
-
businessObjectClass: string
-
communication: integer
(int64)
-
createdDate: string
(date)
-
createdUser: string
-
edge: object
schema
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
exclude: boolean
-
id: string
-
label: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
lineColor: string
-
lineType: string
-
name: string
-
profile: integer
(int64)
-
profileNode: object
ProfileVertex
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
toProfileNode: object
ProfileVertex
Nested Schema : schema
Type:
Show Source
object
-
autoSuggestName: string
-
availableCapacity: boolean
-
businessObjectClass: string
-
capacities: array
capacities
-
costValue1: number
(double)
-
costValue2: number
(double)
-
costValue3: number
(double)
-
createdDate: string
(date)
-
createdUser: string
-
edgeType: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
fromNode: integer
(int64)
-
fromNodeBusinessObjectClass: string
-
fromNodeData: string
-
fromNodeReferenceId: string
-
id: string
-
inventoryStatus: string
-
isChannelized: boolean
-
isPipeInterfaceTerminated: boolean
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
maxBandwidth: number
-
maxContiguousChannels: integer
(int32)
-
name: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
ratecode: string
-
referenceId: integer
(int64)
-
specName: string
-
technology: string
-
toNode: integer
(int64)
-
toNodeBusinessObjectClass: string
-
toNodeData: string
-
toNodeReferenceId: string
-
unitBitRate: number
Nested Schema : ProfileVertex
Type:
Show Source
object
-
businessObjectClass: string
-
createdDate: string
(date)
-
createdUser: string
-
device: integer
(int64)
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
exclude: boolean
-
id: string
-
imageName: string
-
label: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
location: integer
(int64)
-
name: string
-
nec: integer
(int64)
-
network: integer
(int64)
-
profile: integer
(int64)
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
vertex: object
Vertex
-
xPos: integer
(int32)
-
yPos: integer
(int32)
Nested Schema : Vertex
Type:
Show Source
object
-
activeEvent: integer
(int64)
-
activeEventDesc: string
-
area: string
-
autoSuggestName: string
-
availablePositions: string
-
businessObjectClass: string
-
category: string
-
circle: string
-
city: string
-
communication: integer
(int64)
-
country: string
-
createdDate: string
(date)
-
createdUser: string
-
deviceIdentifier: string
-
district: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
equipmentCategory: string
-
fromNodeSubNetwork: integer
(int64)
-
id: string
-
inventoryStatus: string
-
ipv4: string
-
ipv4Subnet: string
-
ipv6: string
-
ipv6Subnet: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
latitude: number
(double)
-
locationCode: string
-
longitude: number
(double)
-
macAddress: string
-
name: string
-
networkStatus: string
-
nodeCategory: string
-
nodeType: string
-
occupiedPositions: string
-
operator: string
-
postalCode: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
province: string
-
referenceId: integer
(int64)
-
region: string
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
specName: string
-
state: string
-
subCategory: string
-
subNetworkEntityId: integer
(int64)
-
subNetworkName: string
-
subType: string
-
toNodeSubNetwork: integer
(int64)
-
topologyType: string
-
zoneId: string
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
JSON response after creating the Profile
Root Schema : schema
Type:
Show Source
object
-
alarmSummary: object
AlarmSummary
-
businessObjectClass: string
-
createdDate: string
(date)
-
createdUser: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
id: string
-
json: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
name: string
-
profileEdges: array
profileEdges
-
profileVertices: array
profileVertices
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
referenceId: integer
(int64)
-
refresh: boolean
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
status: string
-
zoomLevel: integer
(int32)
Nested Schema : ProfileEdge
Type:
Show Source
object
-
businessObjectClass: string
-
communication: integer
(int64)
-
createdDate: string
(date)
-
createdUser: string
-
edge: object
schema
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
exclude: boolean
-
id: string
-
label: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
lineColor: string
-
lineType: string
-
name: string
-
profile: integer
(int64)
-
profileNode: object
ProfileVertex
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
toProfileNode: object
ProfileVertex
Nested Schema : schema
Type:
Show Source
object
-
autoSuggestName: string
-
availableCapacity: boolean
-
businessObjectClass: string
-
capacities: array
capacities
-
costValue1: number
(double)
-
costValue2: number
(double)
-
costValue3: number
(double)
-
createdDate: string
(date)
-
createdUser: string
-
edgeType: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
fromNode: integer
(int64)
-
fromNodeBusinessObjectClass: string
-
fromNodeData: string
-
fromNodeReferenceId: string
-
id: string
-
inventoryStatus: string
-
isChannelized: boolean
-
isPipeInterfaceTerminated: boolean
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
maxBandwidth: number
-
maxContiguousChannels: integer
(int32)
-
name: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
ratecode: string
-
referenceId: integer
(int64)
-
specName: string
-
technology: string
-
toNode: integer
(int64)
-
toNodeBusinessObjectClass: string
-
toNodeData: string
-
toNodeReferenceId: string
-
unitBitRate: number
Nested Schema : ProfileVertex
Type:
Show Source
object
-
businessObjectClass: string
-
createdDate: string
(date)
-
createdUser: string
-
device: integer
(int64)
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
exclude: boolean
-
id: string
-
imageName: string
-
label: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
location: integer
(int64)
-
name: string
-
nec: integer
(int64)
-
network: integer
(int64)
-
profile: integer
(int64)
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
vertex: object
Vertex
-
xPos: integer
(int32)
-
yPos: integer
(int32)
Nested Schema : Vertex
Type:
Show Source
object
-
activeEvent: integer
(int64)
-
activeEventDesc: string
-
area: string
-
autoSuggestName: string
-
availablePositions: string
-
businessObjectClass: string
-
category: string
-
circle: string
-
city: string
-
communication: integer
(int64)
-
country: string
-
createdDate: string
(date)
-
createdUser: string
-
deviceIdentifier: string
-
district: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
equipmentCategory: string
-
fromNodeSubNetwork: integer
(int64)
-
id: string
-
inventoryStatus: string
-
ipv4: string
-
ipv4Subnet: string
-
ipv6: string
-
ipv6Subnet: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
latitude: number
(double)
-
locationCode: string
-
longitude: number
(double)
-
macAddress: string
-
name: string
-
networkStatus: string
-
nodeCategory: string
-
nodeType: string
-
occupiedPositions: string
-
operator: string
-
postalCode: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
province: string
-
referenceId: integer
(int64)
-
region: string
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
specName: string
-
state: string
-
subCategory: string
-
subNetworkEntityId: integer
(int64)
-
subNetworkName: string
-
subType: string
-
toNodeSubNetwork: integer
(int64)
-
topologyType: string
-
zoneId: string
Examples
400 Response
The request isn't valid
401 Response
The request is unauthorized
403 Response
The request is forbidden
404 Response
The requested resource not found
500 Response
An Internal Server Error has occurred