openapi: 3.0.0
info:
title: netTerrain RESTful API V1
contact: {}
version: '1'
servers:
- url: http://172.30.1.110:80/vis
variables: {}
paths:
/wapi/v1/{parent_type_group}/{parent_id}/cards:
get:
tags:
- Nodes / Cards
summary: RESTfulCards_Get
description: Gets the cards collection.
operationId: RESTfulCards_Get
parameters:
- name: parent_type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: parent_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/cards:
get:
tags:
- Nodes / Cards
summary: GetRESTfulCards_Get
description: Gets the cards collection.
operationId: GetRESTfulCards_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/cards/{id}:
get:
tags:
- Nodes / Cards
summary: RESTfulCards_GetById
description: 'Card id example: 24000000000123'
operationId: RESTfulCards_GetById
parameters:
- name: id
in: path
description: Card id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing card.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Card'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Card'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Cards
summary: RESTfulCards_Put
description: "
Use this card format for card update:\r\n \r\n {\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004463\"\r\n },\r\n \"name\": \"3Com 3C200500\",\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"offline\"\r\n }"
operationId: RESTfulCards_Put
parameters:
- name: id
in: path
description: Card id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: C7Mb0QFsNqmHjA9GIhO9EsbBQczeic1ZfBvL9z8BybgViJdVxVpiIJI5sKsRTm13W2i4wpFNelDFZC9WpznO3DfwKba1t-gGVQ6zUvlHw3tWTmnQy526wbg0ZfIekaNxm4pFRVkHSJBfuwWGjADtAw2
requestBody:
description: Updated card.
content:
application/json:
schema:
type: object
description: Updated card.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Nodes / Cards
summary: RESTfulCards_Delete
description: Deleted card is replaced by a slot.
operationId: RESTfulCards_Delete
parameters:
- name: id
in: path
description: Card id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: EX7XEC3humpOLgJCms1AejL_vLxKruBC-tAu0Gr8_zEmZt50sb_LGpEYHiY26r5V3K6ouGWkf2Dhw_HJA0J0D1EHOteahimbsrEgG93XIRTTAhGSwbcavUKmZJnUe7yZO4RYNHgIr7rQCbuYFx-8ag2
responses:
'200':
description: Card deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'422':
description: Object by 'Card id' is not a card.
headers: {}
content: {}
'500':
description: Card deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{node_id}/ports:
get:
tags:
- Nodes / Ports
summary: RESTfulPorts_Get
description: Gets the ports collection.
operationId: RESTfulPorts_Get
parameters:
- name: type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{node_id}/ports/{id}:
get:
tags:
- Nodes / Ports
summary: RESTfulPorts_GetById
description: 'Port id example: 23000000000123'
operationId: RESTfulPorts_GetById
parameters:
- name: type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing port.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Port'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Port'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/ports:
get:
tags:
- Nodes / Ports
summary: GetRESTfulPorts_Get
description: >-
This collection is useful when direct access to ports is required.
For example, to search a port by its name and value when a parent device or card is unknown.
operationId: GetRESTfulPorts_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{node_id}/ports/{id}/links:
get:
tags:
- Links
summary: RESTfulLinks_Get
description: Gets the collection of links linked to a specific port.
operationId: RESTfulLinks_Get
parameters:
- name: type_group
in: path
description: "Port's parent node type: 'device' or 'card'."
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Port's parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port's id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/links:
get:
tags:
- Links
summary: GetRESTfulLinks_Get
description: Gets the links collection.
operationId: GetRESTfulLinks_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Links
summary: RESTfulLinks_Put
description: "
Use this format for link update:\r\n \r\n {\r\n \"name\": \"New Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000000123\"\r\n }"
operationId: RESTfulLinks_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: I0LqzS_CuwgzGJMIhex_devDd_aFEmBrE_BcrRa1EkzKfA7yKl1QUmSR8s9bOb20ydcyaORMhOpmUkx1SpcD4DeS3YEtHQrFBoj0jNLYNEAawrcRZLC02Kx2hIVn_7X2GSpASFkDBw_kQ9_p9_PsJw2
requestBody:
description: Updated link.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Link'
- description: Updated link.
required: true
responses:
'200':
description: Link update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link cannot be found.
headers: {}
content: {}
'500':
description: Link update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Links
summary: RESTfulLinks_Post
description: "
Use this format for link creation:\r\n \r\n {\r\n \"name\": \"Link Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }\r\n }\r\n \r\n Use this format to link ports:\r\n \r\n {\r\n \"name\": \"Link Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000018918/ports/23000000021462\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000018918/ports/23000000021462\"\r\n }\r\n }\r\n \r\n \"name\" or/and \"link_type\" attributes may be ommitted. A default name \"Link\" and a default\r\n link type will be used for link creation in this case:\r\n \r\n {\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }\r\n }"
operationId: RESTfulLinks_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: gOa7yWALrOQgwOj2_N9kJJHYaVij1d_TPzF8kjdM6OuwVGEri8yoSgYVc2TmtYM7MXf__3eXHCRfU1drsFDtgfrJSJr-noa4czUOcY3Swaf75-zJH66UZM88NE5FgZ-ZkXnu-J8ixUol7-TkA3t0xg2
requestBody:
description: New link.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Link'
- description: New link.
required: true
responses:
'201':
description: Link creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link should not contain 'href'.
headers: {}
content: {}
'500':
description: Link creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{id}:
get:
tags:
- Links
summary: RESTfulLinks_GetById
description: 'Link id example: 25000000000123'
operationId: RESTfulLinks_GetById
parameters:
- name: id
in: path
description: Link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Link'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Link'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Links
summary: PutRESTfulLinks_Put
description: "
Use this format for link update:\r\n \r\n {\r\n \"name\": \"New Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000000123\"\r\n }"
operationId: PutRESTfulLinks_Put
parameters:
- name: id
in: path
description: Link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: lfWSWfl11B9FGC9NIoqIGul6LB_p6Xa2XKVzzEPJ64QQeBmjUyB3LbTMJ9ppQoLX7OFHr0j3S5tNG7ggQkFWWsZRfpP454d-b0O6xL0zQf1Dl8iQPgEj5sfRaonIHQvGaUno_kbuUS1v-0CjOzQCpQ2
requestBody:
description: Updated link.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Link'
- description: Updated link.
required: true
responses:
'200':
description: Link update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link cannot be found.
headers: {}
content: {}
'500':
description: Link update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Links
summary: RESTfulLinks_Delete
description: Deletes a link.
operationId: RESTfulLinks_Delete
parameters:
- name: id
in: path
description: Link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: nsyO6qIVRGGoCAmV9hZ7p_1VOFaxEI7hIJIh71hCpYeriRC3ocPPruNL7uWydra9TAj4UR-9IOFEZWVfhYEKiyTX_ieTekUzFjMKOryLxmndrjjBgAF9NRLF6Q0u03Utrg5_SUVAsuSiEOfikyp_Kg2
responses:
'200':
description: Link deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Link deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{node_id}/slots:
get:
tags:
- Nodes / Slots
summary: RESTfulSlots_Get
description: Gets the slots collection.
operationId: RESTfulSlots_Get
parameters:
- name: type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{node_id}/slots/{id}:
get:
tags:
- Nodes / Slots
summary: RESTfulSlots_GetById
description: 'Slot id example: 24000000000123'
operationId: RESTfulSlots_GetById
parameters:
- name: type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing slot.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Slot'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Slot'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
post:
tags:
- Nodes / Slots
summary: RESTfulSlots_Post
description: "The slot disappears from Slots collection after card insertion.\r\n\r\n name parameter renames the slot if set, a new card uses the slot's name.\r\n
Use this node format for new card creation:\r\n \r\n {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000000123\"\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004463\"\r\n },\r\n \"name\": \"3Com 3C200500\",\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"installed\",\r\n }"
operationId: RESTfulSlots_Post
parameters:
- name: type_group
in: path
description: 'Parent node type group: either "devices" or "cards".'
required: true
style: simple
schema:
type: string
- name: node_id
in: path
description: Parent node (device or card) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: _-Mz6ycLl--iogPASoMv_clcCXxD85eHYHXwMyEsQ4iQUUZfI5jLb8jvweUe3VD-THr_wU53wYdeox5UNIfvp1lwEW85o_uc4Ht2_eeMaMXJlUMt6ypkkSCrLtdl2s7-MQjAlOi9plEMxwQYp6k6JA2
requestBody:
description: New card.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Card'
- description: New card.
required: true
responses:
'201':
description: Card creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Other than 'Card' base node type.
headers: {}
content: {}
'409':
description: Conflict - a new card should not contain 'href'.
headers: {}
content: {}
'500':
description: Card creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/slots:
get:
tags:
- Nodes / Slots
summary: GetRESTfulSlots_Get
description: >-
This collection is useful when direct access to slots is required.
For example, to search a slot by its name and value when a parent device or card is unknown.
operationId: GetRESTfulSlots_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{type_id}/port_representations:
get:
tags:
- Node Types / Port Representations
summary: RESTfulPortRepresentations_Get
description: Gets the port representations collection for a type.
operationId: RESTfulPortRepresentations_Get
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Port Representations
summary: RESTfulPortRepresentations_Post
description: "
Use this card type's port representation format for port type's port representation creation:\r\n \r\n {\r\n }"
operationId: RESTfulPortRepresentations_Post
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: QFmBufBFtvcLwL1P42UjwICoZMIxf0BiesD93jLOIdJ_fU6r91kQ_fcWGTXDB_OQ_5FRDHeoyH_WBsoGJCY-RGKGAfgQ7WEovCCB79-89HfGVFPjU30KqDU4mMOlOn0ldlS3nv768OolOaxfjZCi-A2
requestBody:
description: New card type's port representation body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
- description: New card type's port representation body.
required: true
responses:
'201':
description: Card type's port representation creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new port type's port representation should not contain
'href'.
headers: {}
content: {}
'500':
description: Card type's port representation creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/port_representations/{id}:
get:
tags:
- Node Types / Port Representations
summary: RESTfulPortRepresentations_GetById
description: Gets the port representation belonging to the card or device type.
operationId: RESTfulPortRepresentations_GetById
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the port representation of the existing card or device type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Port Representations
summary: RESTfulPortRepresentations_Put
description: "
Use this port representation format for port representation update:\r\n \r\n {\r\n }"
operationId: RESTfulPortRepresentations_Put
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Parent type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: g7ETmHun_xLVUoJUFdBReuaNzYWCHPiRmmB45CGyJw_ItvlWVlWLNmomAcfBb3gIJQCTYwVKdlqpbuYB5fWCauC9DnowLlAvcpbeC0SvJTqAvh7CXDnx4Zhs8dPjkxDDR0jmw9yaGcqEknD7D_F1Ww2
requestBody:
description: Card type's port representation body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
- description: Card type's port representation body with updated data.
required: true
responses:
'200':
description: Card type's port representation update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The card type's port representation cannot be found.
headers: {}
content: {}
'500':
description: Card type's port representation update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Port Representations
summary: RESTfulPortRepresentations_Delete
description: Deletes the card type's port representation.
operationId: RESTfulPortRepresentations_Delete
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: NWpeeWT5uSk5tOo87iG-r5ptlMSBCsM52V7VCkcNPEvi3u8xcZOnV1lRzk5W6Lkmr1djJhfei1q6MxEKvy3A87G7CV9ZAwhMQxajZep8c7ccqSnSSEUArBKOQQeTd7TgLPV8pLEW_tqiAfH4JdVzWA2
responses:
'200':
description: Port representation deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Port representation deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/port_representations:
get:
tags:
- Node Types / Port Representations
summary: GetRESTfulPortRepresentations_Get
description: >-
This collection is useful when direct access to port representations is needed. For example,
to find ports of certain capacity.
operationId: GetRESTfulPortRepresentations_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Port Representations
summary: PutRESTfulPortRepresentations_Put
description: "
Use this port representation format for port representation update:\r\n \r\n {\r\n }"
operationId: PutRESTfulPortRepresentations_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 2vZ8nuK_tNO2LwycnfUHfV04A5k1znBlxq9EFTRl7rVSdWMuQ6KdUAojWTLFSwpx_PuYWubdGuRXtJRjOKaqe4BzuhkOGdnxRVHjf_XP3x3zqCgDNv27ZbiI_PYwci6oQmoXmVkH2ZNs9Tcq_Z-JQQ2
requestBody:
description: Card type's port representation body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
- description: Card type's port representation body with updated data.
required: true
responses:
'200':
description: Card type's port representation update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The card type's port representation cannot be found.
headers: {}
content: {}
'500':
description: Card type's port representation update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Port Representations
summary: PostRESTfulPortRepresentations_Post
description: "
Use this card type's port representation format for card type's port representation creation:\r\n \r\n {\r\n }"
operationId: PostRESTfulPortRepresentations_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: p6LhIRvTgLHQDjk3e7rG13vkEPfZDT7RnkLQHNn4c05gCjslIqGrKBXg_e7bV-1GNC4IZK4-hcS9ljyrf78a8MBcxDlhKtL4UrZuZUqFtgfxFOEWJ5IAUl6F4LqJZT_UrD03CMlKuQUE6OeW0wttwA2
requestBody:
description: New card type's port representation body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortRepresentation'
- description: New card type's port representation body.
required: true
responses:
'201':
description: Card type's port representation creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new card type's port representation should not contain
'href'.
headers: {}
content: {}
'500':
description: Card type's port representation creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/port_representations/{id}:
get:
tags:
- Node Types / Port Representations
summary: GetRESTfulPortRepresentations_GetById
description: 'Card type id example: 26000000014512'
operationId: GetRESTfulPortRepresentations_GetById
parameters:
- name: id
in: path
description: Port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the port representation of the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/port_representations/{port_representation_id}/port_fields:
get:
tags:
- Node Types / Port Representations / Port Fields
summary: RESTfulPortFields_Get
description: Gets the port fields collection for a port representation.
operationId: RESTfulPortFields_Get
parameters:
- name: port_representation_id
in: path
description: Host port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{type_id}/port_representations/{port_representation_id}/port_fields/{id}:
get:
tags:
- Node Types / Port Representations / Port Fields
summary: RESTfulPortFields_GetById
description: Gets the port field by id.
operationId: RESTfulPortFields_GetById
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: port_representation_id
in: path
description: Host port representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Port field id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the port field of the existing port representation type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortField'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.PortField'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/port_fields:
get:
tags:
- Node Types / Port Representations / Port Fields
summary: GetRESTfulPortFields_Get
description: This collection is useful when direct access to port fields is needed.
operationId: GetRESTfulPortFields_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/port_fields/{id}:
get:
tags:
- Node Types / Port Representations / Port Fields
summary: GetRESTfulPortFields_GetById
description: Gets the port field by id.
operationId: GetRESTfulPortFields_GetById
parameters:
- name: id
in: path
description: Port field id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the port field of the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations:
get:
tags:
- Node Types / Slot Representations
summary: RESTfulSlotRepresentations_Get
description: Gets the slot eepresentations collection for a type.
operationId: RESTfulSlotRepresentations_Get
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Slot Representations
summary: RESTfulSlotRepresentations_Post
description: "
Use this slot representation format for slot representation creation:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }"
operationId: RESTfulSlotRepresentations_Post
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: B8jgfc2rVLCQWUVJ57LriteUOO26jZ_daFRRbnnO1qb28f1oXYYCGJCw6QBM_wvlrbDd7PtdSJvaDhlK54euF5hOk98zxiZEJ14uQhCXFbEv7t4RwBpsn2n8dLj-L_M1lI-qX52QV_Jg-h6Ac_w9dQ2
requestBody:
description: New slot representation body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
- description: New slot representation body.
required: true
responses:
'201':
description: Slot representation creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new slot representation should not contain 'href'.
headers: {}
content: {}
'500':
description: Slot representation creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations/{id}:
get:
tags:
- Node Types / Slot Representations
summary: RESTfulSlotRepresentations_GetById
description: Gets the slot representation belonging to the card or device type.
operationId: RESTfulSlotRepresentations_GetById
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot representation of the existing card or device type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Slot Representations
summary: RESTfulSlotRepresentations_Put
description: "
Use this slot representation format for slot representation update:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }"
operationId: RESTfulSlotRepresentations_Put
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Parent type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Q5wBbWVfZDUyczrZQdIXey37sSMmEiAHE5fJHJNQvgQKxxWDJtQl4p0wxe2UwqnEhi-danZI4NYXdqEOkxCITLexNA2GmnbvhMYEw96Hcwqs1jZiP2olWfz2F9S0vnaHdecZV4iQMujVibLu-WS7AA2
requestBody:
description: Slot representation body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
- description: Slot representation body with updated data.
required: true
responses:
'200':
description: Slot representation update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The card type's slot representation cannot be found.
headers: {}
content: {}
'500':
description: Slot representation update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Slot Representations
summary: RESTfulSlotRepresentations_Delete
description: Deletes the card type's slot representation.
operationId: RESTfulSlotRepresentations_Delete
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Xojjz4d6JESE5RiVvaV31ls0ackOzSZAoT-bZbHxGzkk5Nyn5kA2hVcJbmb8e4Q-jsHTQbueIw0uPsniDLrVqQZEi7nteUUcOfD-SaOPViaexxgsCGKizd5QOmmLEMfnho4ICc0exwsJWOCjCYO1cA2
responses:
'200':
description: Slot representation deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Slot representation deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/slot_representations:
get:
tags:
- Node Types / Slot Representations
summary: GetRESTfulSlotRepresentations_Get
description: >-
This collection is useful when direct access to slot representations is needed.
For example, to find slots of certain capacity.
operationId: GetRESTfulSlotRepresentations_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Slot Representations
summary: PutRESTfulSlotRepresentations_Put
description: "
Use this slot representation format for slot representation update:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000002684/slot_representations/2744\"\r\n }"
operationId: PutRESTfulSlotRepresentations_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: JQBedcPOdzqZ-ahoqVdCPFOW6xGAJDYGbMhSm3DN3baTxb0ux9nYkvcCnH6QBw7C4mv6OYEBAspdbqqYhj8C9ojAE-iEKkRrWNl474_UitzlaxsQt2DPQnf4A4VWmj11f4lS6GQTQAs2A1cRM8YkXg2
requestBody:
description: Slot representation body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
- description: Slot representation body with updated data.
required: true
responses:
'200':
description: Slot representation update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The slot representation cannot be found.
headers: {}
content: {}
'500':
description: Slot representation update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Slot Representations
summary: PostRESTfulSlotRepresentations_Post
description: "
Use this card type's slot representation format for slot representation creation:\r\n \r\n {\r\n \"parent_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/v1/device_types/26000000002684\"\r\n },\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }"
operationId: PostRESTfulSlotRepresentations_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: rasxXagaab0p8Y07e1yrtE9qgio9K1ZXrFaHDJQmpRdZReFYBGr_cxFKm_BKeN2-4MmQKr1kL2tEhxJgqbxYweGWs7czjgo34lGjsVHmDNHMf3o_ePTG3krQFcFVb_Jyaxrsi_iMwXwi8PDbfsu_LQ2
requestBody:
description: New slot representation body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotRepresentation'
- description: New slot representation body.
required: true
responses:
'201':
description: Card type's slot representation creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new card type's slot representation should not contain
'href'.
headers: {}
content: {}
'500':
description: Slot representation creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/slot_representations/{id}:
get:
tags:
- Node Types / Slot Representations
summary: GetRESTfulSlotRepresentations_GetById
description: 'Card type id example: 26000000014512'
operationId: GetRESTfulSlotRepresentations_GetById
parameters:
- name: id
in: path
description: Slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot representation of the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations/{slot_representation_id}/slot_fields:
get:
tags:
- Node Types / Slot Representations / Slot Fields
summary: RESTfulSlotFields_Get
description: Gets the slot fields collection for a slot representation.
operationId: RESTfulSlotFields_Get
parameters:
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations/{slot_representation_id}/slot_fields/{id}:
get:
tags:
- Node Types / Slot Representations / Slot Fields
summary: RESTfulSlotFields_GetById
description: Gets the slot field by id.
operationId: RESTfulSlotFields_GetById
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot field id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot field of the existing slot representation type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotField'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotField'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/slot_fields:
get:
tags:
- Node Types / Slot Representations / Slot Fields
summary: GetRESTfulSlotFields_Get
description: This collection is useful when direct access to slot fields is needed.
operationId: GetRESTfulSlotFields_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/slot_fields/{id}:
get:
tags:
- Node Types / Slot Representations / Slot Fields
summary: GetRESTfulSlotFields_GetById
description: Gets the slot field by id.
operationId: GetRESTfulSlotFields_GetById
parameters:
- name: id
in: path
description: Slot field id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot field of the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations/{slot_representation_id}/slot_mapping:
get:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: RESTfulSlotMapping_Get
description: Gets the slot mappings collection for a slot representation.
operationId: RESTfulSlotMapping_Get
parameters:
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: RESTfulSlotMapping_Post
description: "
Use this slot mapping format for slot mapping creation:\r\n \r\n {\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004993\"\r\n }\r\n }"
operationId: RESTfulSlotMapping_Post
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: K_7IXEnO68VFL7rz0q8OYrQyy1GD2KpzqHl8XFa2PT4I-T4ZTSL5UcNoVWh8FTFxzuWqM-2IQyfmh_ZGEqojEyKURbQiYK--u32cu9bUw2xQBD5hXWBiGZcUI_VeK0hkYzgUvDTJffPY8h5d-yxlJg2
requestBody:
description: New slot mapping body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotMapping'
- description: New slot mapping body.
required: true
responses:
'201':
description: Slot mapping creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new slot mapping should not contain 'href'.
headers: {}
content: {}
'500':
description: Slot mapping creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/{type_group}/{type_id}/slot_representations/{slot_representation_id}/slot_mapping/{id}:
get:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: RESTfulSlotMapping_GetById
description: Gets the slot mapping by id.
operationId: RESTfulSlotMapping_GetById
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot mapping id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot mapping of the existing slot representation type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotMapping'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotMapping'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: RESTfulSlotMapping_Delete
description: Deletes the card type's slot mapping.
operationId: RESTfulSlotMapping_Delete
parameters:
- name: type_group
in: path
description: "Type group: 'card_types' or 'device_types'."
required: true
style: simple
schema:
type: string
- name: type_id
in: path
description: Host type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: slot_representation_id
in: path
description: Host slot representation id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Slot mapping id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 1ZTBIIvsuZHdzDS15pLAUfg8EMm7d4Umi5e-nf5DEJmkDD7JeGVL2Q5Nhnh0ne5ziYaPdNMlb7J6hLksieVGOPejPqNyGwg3kkOfKfvNhOKlY-UJTVIpq5LKDqBwPeOdLQq4RZNhiuxAvjFyvmulpw2
responses:
'200':
description: Slot mapping deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Slot mapping deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/slot_mapping:
get:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: GetRESTfulSlotMapping_Get
description: This collection is useful when direct access to slot mappings is needed.
operationId: GetRESTfulSlotMapping_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: PostRESTfulSlotMapping_Post
description: "
Use this card type's slot mapping format for slot mapping creation:\r\n \r\n {\r\n \"slot_representation\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000002684/slot_representations/2745\"\r\n },\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004993\"\r\n }\r\n }"
operationId: PostRESTfulSlotMapping_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: PFCOI9-BFKteSgrvFHL0rv8R7TTN98QE-We5lYRKjbXXeiz5_fN3DcWJ5rmeKmRY21K1ZUqvR1xeM5Z-ZdHBIp0VqgLG81y-E925Y5g6afo74guYDkk0xIy0y49_R_Q-1W4SUf398o_HtL8XqkoL0Q2
requestBody:
description: New slot mapping body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.SlotMapping'
- description: New slot mapping body.
required: true
responses:
'201':
description: Card type's slot mapping creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new card type's slot mapping should not contain
'href'.
headers: {}
content: {}
'500':
description: Slot mapping creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/slot_mapping/{id}:
get:
tags:
- Node Types / Slot Representations / Slot Mappings
summary: GetRESTfulSlotMapping_GetById
description: Gets the slot mapping by id.
operationId: GetRESTfulSlotMapping_GetById
parameters:
- name: id
in: path
description: Slot mapping id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the slot mapping of the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/card_types:
get:
tags:
- Node Types / Card Types
summary: RESTfulCardTypes_Get
description: Gets the card types collection.
operationId: RESTfulCardTypes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Card Types
summary: RESTfulCardTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the card type cannot be changed.\r\nWhen altering the name parameter (renaming the card type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite card type or a card type with existing card instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current card type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Card' type group.\r\n \r\n
Use this card type format for card override update:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"name\": \"My Card Type\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My card description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000010042\"\r\n }"
operationId: RESTfulCardTypes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: LW6ftYpiL0SqdDq4bmfK9hGQaIYDVqpM-0kIXSL0oylqYJza3qnTifDcOKgtNKzPJqgnn9AoouOS6rd4JVl_SAqRHsg8KjLiNNPn-Lcmw_CdqhJyfgj9TeDEu2hGepyzH6_AaWqP15Oy1itk-n08Vg2
requestBody:
description: Updated card type.
content:
application/json:
schema:
type: object
description: Updated card type.
required: true
responses:
'200':
description: Card type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The card type cannot be found.
headers: {}
content: {}
'500':
description: Card type update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Card Types
summary: RESTfulCardTypes_Post
description: "
Use this card types format for card type create:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"image\": \"MyCard.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My card type\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: RESTfulCardTypes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 1RxTZdSTLMNjiGplHo0n3PrgEXU2uHMzq6izx6cQid0m_CqBYuwfMTjrUfNbKh53SXtGehqGqTpZBtvvacZ_BRDkWiW5o_CXNzBgNRBAaebokKlsZUkpp1DP-wq5zJcad760uwRNI8zObQQ4yYFUFQ2
requestBody:
description: New card type.
content:
application/json:
schema:
type: object
description: New card type.
required: true
responses:
'201':
description: Card type creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new card type should not contain 'href'.
headers: {}
content: {}
'500':
description: Card type creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/card_types/{id}:
get:
tags:
- Node Types / Card Types
summary: RESTfulCardTypes_GetById
description: 'Card type id example: 26000000000123'
operationId: RESTfulCardTypes_GetById
parameters:
- name: id
in: path
description: Card type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing card type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CardType'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CardType'
'400':
description: Node type of a different type group.
headers: {}
content: {}
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Card Types
summary: PutRESTfulCardTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the card type cannot be changed.\r\nWhen altering the name parameter (renaming the card type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite card type or a card type with existing card instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current card type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Card' type group.\r\n \r\n
Use this card type format for card override update:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"name\": \"My Card\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My card description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: PutRESTfulCardTypes_Put
parameters:
- name: id
in: path
description: Card type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: AMj_ceEikk1qHo_NSB5jtNAHibXqBJycVtiXBzgvpVwoIfG3l69ETbiMryHVjUdJDDb1xdNVOdqBtzxuz8AaZrQ-aL5oZxTsUU_-0Nj2Sn9E1yQonz3iccYKvnk4MPgFO4Cf-IAWr1gXbPJhrwzyJg2
requestBody:
description: Updated card type.
content:
application/json:
schema:
type: object
description: Updated card type.
required: true
responses:
'200':
description: Card type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The card type cannot be found.
headers: {}
content: {}
'500':
description: Card type update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Card Types
summary: RESTfulCardTypes_Delete
description: Only types without associated cards can be deleted.
operationId: RESTfulCardTypes_Delete
parameters:
- name: id
in: path
description: Card type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: t_K2XKL73oM8quYx-ma-BA2zlqe9UfEIdAjwCtKASkwekXyGboVctthiCGeK9jEQtg9FMJh-_0dbSzaT-M6o7zcD3_dag2JMid23k8fdSxu2nPJgTgxBbBdjrjRbE4HdHQeAec7u4UQHu4ODM-bSrQ2
responses:
'200':
description: Card type deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Card type deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuit_properties:
get:
tags:
- Circuit Properties
summary: RESTfulCircuitProperties_Get
description: Gets the circuit properties collection.
operationId: RESTfulCircuitProperties_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Circuit Properties
summary: RESTfulCircuitProperties_Put
description: "When altering the name parameter (renaming the circuit property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name.\r\n
\r\n
Use this circuit properties format for circuit override update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"show_in_acra\": true,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/circuit_properties/43000000003733\"\r\n }"
operationId: RESTfulCircuitProperties_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: w0EvJbWZqKiV2YnzbpyvY_x1zCR6RpcMHS1QzSMVvSkf_y6HQMwvpmAG1RyJ9JegDAlEq5aoNoBcPo_UZ4mv6WJD6sQ3q_KV6do_nAx5-3AVQ9rkOgmJTd1kOMdDeiXrEGL1XlYaAkLc_8bhDt_oFg2
requestBody:
description: Updated circuit property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitProperty'
- description: Updated circuit property.
required: true
responses:
'200':
description: Circuit property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The circuit property cannot be found.
headers: {}
content: {}
'500':
description: Circuit property update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Circuit Properties
summary: RESTfulCircuitProperties_Post
description: "
Use this circuit property format for circuit property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"show_in_acra\": true\r\n }"
operationId: RESTfulCircuitProperties_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: LkfmlotVdE1scpqU1GtcZl5RbenKgtwILHVKiASA29OhZjScGWdl7s00GdRM0r-mWREGWxHNo9RTaNiaq0ztZ5gVIEnVlmYTg7DCeNDlUhk23hHFFfDBCn8wzMXGeJoT9PsGvt5wlqPdiJFQcpTSaw2
requestBody:
description: New circuit property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitProperty'
- description: New circuit property.
required: true
responses:
'201':
description: Circuit property creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new circuit property should not contain 'href'.
headers: {}
content: {}
'500':
description: Circuit property creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuit_properties/{id}:
get:
tags:
- Circuit Properties
summary: RESTfulCircuitProperties_GetById
description: 'Circuit property id example: 43000000000076'
operationId: RESTfulCircuitProperties_GetById
parameters:
- name: id
in: path
description: Circuit property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing circuit property.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitProperty'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitProperty'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Circuit Properties
summary: RESTfulCircuitProperties_Delete
description: Only non-system circuit properties can be deleted.
operationId: RESTfulCircuitProperties_Delete
parameters:
- name: id
in: path
description: Circuit property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: a2kitVXY30t1Q52UShbWE-sc5r3B16OEkvmB9XNmXhTD0wvQkT3bvvGHwxYIBa-awX3d2ijHtpCoUkXf4rCC_-6lep9BfuS_eRi1AF68fAyHzzR700WHLJj8VycE9IEuXXL-rgBLXUDXkINf6ldDgg2
responses:
'200':
description: Circuit property deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Circuit property deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuit_property_values:
get:
tags:
- Circuits / Property Values
summary: RESTfulCircuitPropertyValues_Get
description: Gets the circuit property values collection with no relation to a specific circuit.
operationId: RESTfulCircuitPropertyValues_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/circuits/{circuit_id}/circuit_property_values:
get:
tags:
- Circuits / Property Values
summary: GetRESTfulCircuitPropertyValues_Get
description: Gets the circuit property values collection.
operationId: GetRESTfulCircuitPropertyValues_Get
parameters:
- name: circuit_id
in: path
description: Parent circuit id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Circuits / Property Values
summary: RESTfulCircuitPropertyValues_Put
description: "
Use this circuit property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/circuits/37000000010516/circuit_property_values/44000000013595\"\r\n }"
operationId: RESTfulCircuitPropertyValues_Put
parameters:
- name: circuit_id
in: path
description: Parent circuit id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: eK61ofcBjMypLhEJ6ShTuCg48zSdzQZygx2fp4P4FX1aKQCt0lqh6K97usCjEmREE4wgAnmmM2AEltFRIC7n-muuNOt3-5tspZ-NnjFAsE5pXNfZz-3smFeVUxlYUCZCg0erx62t5WcE1SAILlx4kA2
requestBody:
description: Updated circuit property value id.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitPropertyValue'
- description: Updated circuit property value id.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuits/{circuit_id}/circuit_property_values/{id}:
get:
tags:
- Circuits / Property Values
summary: RESTfulCircuitPropertyValues_GetById
description: 'Circuit id example: 37000000000123, Circuit property value id example: 44000000013595.'
operationId: RESTfulCircuitPropertyValues_GetById
parameters:
- name: circuit_id
in: path
description: Parent circuit id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Circuit property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing circuit property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitPropertyValue'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.CircuitPropertyValue'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuits/{circuit_id}/circuit_property_values/init_absent_values:
post:
tags:
- Circuits / Property Values
summary: RESTfulCircuitPropertyValues_InitAbsentValues
description: Creates absent circuit property values.
operationId: RESTfulCircuitPropertyValues_InitAbsentValues
parameters:
- name: circuit_id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: -gcM_mdv5tHg1W302sEYm47mhPKUdUVt8Ajb7jbIKQAhjRE0QofeQrmQYnWqAUDAgzVPZI5Ms8ekS5zutBUaa5FrMvhIjNNCWthVdeSm1dcEkGTVIlFzJTBxfGtA5xhzgy7MS_0GkFsXZMbt88uCfA2
responses:
'200':
description: All circuit property values has already been created before.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'201':
description: Circuit property values were successfully created.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'404':
description: The circuit does not exist.
headers: {}
content: {}
'500':
description: Circuit property values creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuits:
get:
tags:
- Circuits
summary: RESTfulCircuits_Get
description: Gets the circuits collection.
operationId: RESTfulCircuits_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Circuits
summary: RESTfulCircuits_Post
description: "
Examples:\r\n \r\n Use this data format for creation of new Edge-to-edge circuit:\r\n \r\n {\r\n \"name\": \"New circuit name\",\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000139248\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000139327\"\r\n },\r\n \"patch_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000050\"\r\n }\r\n }\r\n \r\n Use this data format for creation of new End-to-end circuit:\r\n \r\n {\r\n \"name\": \"New circuit name\",\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000139248\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000139327\"\r\n },\r\n \"patch_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000050\"\r\n },\r\n \"from_port_1\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000139248/ports/23000000601832\"\r\n },\r\n \"from_port_2\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000139248/ports/23000000601833\"\r\n },\r\n \"to_port_1\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000139327/ports/23000000602684\"\r\n },\r\n \"to_port_2\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000139327/ports/23000000602685\"\r\n }\r\n }"
operationId: RESTfulCircuits_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ZK3rHMDRCC75BlJaKhWJayelf0rK_8nqV_s_VzLAHtamX42s1vGrV4E8JVA8RAZWqTeBkmXFJg8Py4nnFOIY4xm1Pt_Cg1qRB7pvweoQSFay2Fjcb1r_UP9Bt3orzbQ1-CdIAxSDOI2_Gk0000Me5g2
requestBody:
description: Data for new circuit.
content:
application/json:
schema:
type: object
description: Data for new circuit.
required: true
responses:
'201':
description: Circuit creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Other.
headers: {}
content: {}
'409':
description: Conflict - a new circuit data should not contain 'href'.
headers: {}
content: {}
'500':
description: Circuit creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/circuits/{id}:
get:
tags:
- Circuits
summary: RESTfulCircuits_GetById
description: 'Circuit id example: 37000000000123'
operationId: RESTfulCircuits_GetById
parameters:
- name: id
in: path
description: Circuit id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing circuit.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Circuit'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Circuit'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Circuits
summary: RESTfulCircuits_Delete
description: Deletes a circuit.
operationId: RESTfulCircuits_Delete
parameters:
- name: id
in: path
description: Circuit id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: PeaXWGV2aoKnoH34fKpOYx4e6XST-pgh2YXzwPKGpDYLMeWV4um3lZhCD40I3r1ZJYFqA6-lqaTWEHndKmLJ36hAHbw4zOwuaeVT-1rFfCPs2OieZ8yknROx7BUncMI0J_WHGepeS__k68FVqh6bLg2
responses:
'200':
description: Circuit deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Circuit deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/device_types:
get:
tags:
- Node Types / Device Types
summary: RESTfulDeviceTypes_Get
description: Gets the device types collection.
operationId: RESTfulDeviceTypes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Device Types
summary: RESTfulDeviceTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the device type cannot be changed.\r\nWhen altering the name parameter (renaming the device type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite device type or a device type with existing device instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current device type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Device' type group.\r\n \r\n
Use this device type format for device override update:\r\n \r\n {\r\n \"system_object_id\": \"1.2.3.4.5.6.7.8.9.10\",\r\n \"base_node_type\": {\r\n \"name\": \"My Device Type\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My device description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000010042\"\r\n }"
operationId: RESTfulDeviceTypes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ShRJRq5nXlLvPkMeSwQH8qxpXjimwJyVBDIJMJVBum_dvxWEub1aqzebX8RUYo-nDgA2LzE2xgN3aUkCIOVXtv6qnCYF8XThNbADKzB7yUUWu6k7hJfBpLBqKnLKTYU7xBeybUM4s5ecfOCR9CiajA2
requestBody:
description: Updated device type.
content:
application/json:
schema:
type: object
description: Updated device type.
required: true
responses:
'200':
description: Device type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The device type cannot be found.
headers: {}
content: {}
'500':
description: Device type update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Device Types
summary: RESTfulDeviceTypes_Post
description: "
Use this device types format for device type create:\r\n \r\n {\r\n \"system_object_id\": \"1.2.3.4.5.6.7.8.9.10\",\r\n \"base_node_type\": {\r\n \"image\": \"MyDevice.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My device type\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: RESTfulDeviceTypes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: -4yoVqK20VVdfZvOsuDLqprjLiPNXujaSgjjbO_U9MP13z6cGZpLatoJfOGQDGt3paV5THN0hyeNn_amLze3mQa6jgadP62WA4z2CAEbQcmMQOC2Dpts4sWxtVbhLMS9L-2ISGV_HSSbjYzQ7Ng-YQ2
requestBody:
description: New device type.
content:
application/json:
schema:
type: object
description: New device type.
required: true
responses:
'201':
description: Device type creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new device type should not contain 'href'.
headers: {}
content: {}
'500':
description: Device type creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/device_types/{id}:
get:
tags:
- Node Types / Device Types
summary: RESTfulDeviceTypes_GetById
description: 'Device type id example: 26000000000123'
operationId: RESTfulDeviceTypes_GetById
parameters:
- name: id
in: path
description: Device type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing device type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.DeviceType'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.DeviceType'
'400':
description: Node type of a different type group.
headers: {}
content: {}
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Device Types
summary: PutRESTfulDeviceTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the device type cannot be changed.\r\nWhen altering the name parameter (renaming the device type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite device type or a device type with existing device instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current device type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Device' type group.\r\n \r\n
Use this device type format for device override update:\r\n \r\n {\r\n \"system_object_id\": \"1.2.3.4.5.6.7.8.9.10\",\r\n \"base_node_type\": {\r\n \"name\": \"My Device Type\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My device description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\": 3.2,\r\n \"physical_height\": 1.75,\r\n \"physical_width\": 30.0,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: PutRESTfulDeviceTypes_Put
parameters:
- name: id
in: path
description: Device type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: xMeiWfgL31oGhELyy80CD3v5VI4O8qYronfcifYTir8GdzrRTK-EJXzoRtwuc09m8Fr9zYTys3BrEp-cXFvuO_biH3TkQstfbLCHbIyHJr0aWV4OzhFqHIhNv2Q6CXRV4yVOMyL1K2CoQpiCe1uJ_w2
requestBody:
description: Updated device type.
content:
application/json:
schema:
type: object
description: Updated device type.
required: true
responses:
'200':
description: Device type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The device type cannot be found.
headers: {}
content: {}
'500':
description: Device type update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Device Types
summary: RESTfulDeviceTypes_Delete
description: Only types without associated devices can be deleted.
operationId: RESTfulDeviceTypes_Delete
parameters:
- name: id
in: path
description: Device type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: O0bSc9CBfQv7bHd6FIcoF3nzV7FoWkCMXD0fugo3aGSZaQ_e8BSPfEkYvLj918r7t64Jhur9PBUXpOYxCX2IbWvioqlCfz3H27UIvguQxmDLSKv-n1SfL-P1_S-4WnVAe3MxR9Z8L7xB1MMBTLhKMw2
responses:
'200':
description: Device type deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Device type deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/devices:
get:
tags:
- Nodes / Devices
summary: RESTfulDevices_Get
description: Gets the devices collection.
operationId: RESTfulDevices_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Nodes / Devices
summary: RESTfulDevices_Post
description: "
Use this node format for new device creation:\r\n \r\n Create and mount to a rack container:\r\n \r\n {\r\n \"name\": \"Cisco WS-C2960-24-S\",\r\n \"parent_rack_container\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/racks/24000000010327/containers/38\"\r\n },\r\n \"device_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000003399\"\r\n },\r\n \"container_position\": 27,\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"installed\"\r\n }\r\n \r\n Create without mounting:\r\n \r\n {\r\n \"name\": \"Cisco WS-C2960-24-S\",\r\n \"device_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000003399\"\r\n },\r\n \"base_node\": {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n }\r\n },\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"online\"\r\n }"
operationId: RESTfulDevices_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: F0VZYmSADIMUS8Xp2wgVtVYK3cfRSpo0gCPsJK9cHDsPCL1Jb5fZs9MmOJjFkE2OKswBMt3GhuSA08h8yDawLy14VZQH_b6hRj7EPok2heNqDgIbvzlwPNiTT6ku__WBADmK4GMK3qAjNs5GxUzZ4A2
requestBody:
description: New device.
content:
application/json:
schema:
type: object
description: New device.
required: true
responses:
'201':
description: Device creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Other than 'Device' base node type.
headers: {}
content: {}
'409':
description: Conflict - a new device should not contain 'href'.
headers: {}
content: {}
'500':
description: Device creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/devices/{id}:
get:
tags:
- Nodes / Devices
summary: RESTfulDevices_GetById
description: 'Device id example: 24000000000123'
operationId: RESTfulDevices_GetById
parameters:
- name: id
in: path
description: Device id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing device.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Device'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Device'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Devices
summary: RESTfulDevices_Put
description: "
Use this device format for device update:\r\n \r\n Remount and update properties:\r\n \r\n {\r\n \"parent_rack_container\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/racks/24000000010327/containers/39\"\r\n },\r\n \"container_position\": 29,\r\n \"name\": \"My Device\",\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"online\"\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000010430\"\r\n }\r\n \r\n Dismount:\r\n \r\n {\r\n \"container_position\": -1,\r\n }"
operationId: RESTfulDevices_Put
parameters:
- name: id
in: path
description: Device id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: C_JHPlSAia6nrS9i3LXnqZu_G6nor0SQSZAfNgI3nL6-6QHTtxRXwAMHbhuNnt14J9mRcAIB754XwOqIQkGv_LdHKR1aKtPKqvuxOrsCQX1ldSfqMfFHXrBvrE5YrQCMbbJmedvPELn0ENqgkplhJg2
requestBody:
description: Updated device.
content:
application/json:
schema:
type: object
description: Updated device.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Nodes / Devices
summary: RESTfulDevices_Delete
description: Deletes a device.
operationId: RESTfulDevices_Delete
parameters:
- name: id
in: path
description: Device id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: avHBSmvC7SXGTMXJwjlJ85WrS7rkvgeIaSCuzVacgm_bgJhDGVVXigCbzwEX8pYl93O5db540Ss7uAnCCDHPNPrNrhqnxcnNoVdqDCQ1sc76L7aPplSAUQvhm-GYBt_O1JgqW0PdVRYxfDlDyzN_RA2
responses:
'200':
description: Device deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Device deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/racks/{rack_id}/containers/{container_id}/mounted_devices:
get:
tags:
- Nodes / Devices
summary: GetRESTfulDevices_Get
description: Gets the collection of devices mounted to the rack container.
operationId: GetRESTfulDevices_Get
parameters:
- name: rack_id
in: path
description: Parent rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: container_id
in: path
description: Rack container id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes / Devices
summary: RESTfulDevices_MountDevice
description: "
Use this device format for device mounting:\r\n \r\n {\r\n \"container_position\": 24,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000010430\"\r\n }"
operationId: RESTfulDevices_MountDevice
parameters:
- name: rack_id
in: path
description: Parent rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: container_id
in: path
description: Rack container id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: EA3kUrJArBftdYCXrgpcypIP9eOoGSHYAo_VavJcoPbhhl5YOZDDMPhHZ9e1woX1zT0becVZsxIjRd4x4fsupnjwN3ehOF0cOnYThbE_IGx-7penVSSg-JaLNWZicpAa14W3G5gXR4DHAGDXvEcGUw2
requestBody:
description: The device to mount.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Device'
- description: The device to mount.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/free_text:
get:
tags:
- Free Text
summary: RESTfulFreeText_Get
description: Gets the free text objects collection.
operationId: RESTfulFreeText_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Free Text
summary: RESTfulFreeText_Put
description: "
Use this free text object format:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028499\"\r\n },\r\n \"master_free_text\": null,\r\n \"value\": \"My text\",\r\n \"displayed_value\": \"My text\",\r\n \"x\": 200,\r\n \"y\": 200,\r\n \"z_order\": 0,\r\n \"is_alias\": false,\r\n \"font_size\": 16,\r\n \"color\": \"#132312\",\r\n \"background_color\": \"#A00A01\",\r\n \"justification\": 0,\r\n \"can_move\": true,\r\n \"angle\": -10,\r\n \"is_displayed\": true,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underline\": false,\r\n \"font_family\": \"Lucida console\",\r\n \"align\": 1,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/free_text/16\"\r\n }"
operationId: RESTfulFreeText_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: GR8-PpauNFY9PQK2xsPTbFsh-DOkI57GyzkOoXFaWg6LWoII9WkGDdlDl4wuLqiRMS2JD7MaytJxBPy9Lee3Mg3v7jGcHKwjpcAKzf3GD3G041avQ0Nov6F2zV-1ujouhXRJAzrP4CmQN_8oaPk83g2
requestBody:
description: Updated free text object.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.FreeText'
- description: Updated free text object.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Free Text
summary: RESTfulFreeText_Post
description: "
Use this format for free text object creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028499\"\r\n },\r\n \"value\": \"My text\",\r\n \"x\": 200,\r\n \"y\": 200,\r\n \"z_order\": 0,\r\n \"font_size\": 16,\r\n \"color\": \"#132312\",\r\n \"background_color\": \"#A00A01\",\r\n \"justification\": 0,\r\n \"can_move\": true,\r\n \"angle\": -10,\r\n \"is_displayed\": true,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underline\": false,\r\n \"font_family\": \"Lucida console\",\r\n \"align\": 1,\r\n }"
operationId: RESTfulFreeText_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: guyPnnkMJmUsycCcp41TQRfebufPI-TbWjf8KE_kaEm-EKzdHBpsPT5f9OwscPYskIw8vQ5ceMh-No-P8xD07eDSr1Oso6tQPV1eW_6r4EV9Ylc6ZN2cxJxP5WL3CQssPToRiuPQlzXxgyx0ExAtiw2
requestBody:
description: New free text object.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.FreeText'
- description: New free text object.
required: true
responses:
'201':
description: Free text object creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new free text object should not contain 'href'.
headers: {}
content: {}
'500':
description: Free text object creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/free_text/{id}:
get:
tags:
- Free Text
summary: RESTfulFreeText_GetById
description: Gets the free text object.
operationId: RESTfulFreeText_GetById
parameters:
- name: id
in: path
description: Free text object id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing free text object.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.FreeText'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.FreeText'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Free Text
summary: RESTfulFreeText_Delete
description: Deletes a free text object.
operationId: RESTfulFreeText_Delete
parameters:
- name: id
in: path
description: Free text object id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: gx6jJy0oXcuOaMa4zl9yS7zD_gl40_tUHXMOs3tRtmUE8AZebecVd5yIvE6r02fZzY1WOwmmp049JDWPfueJoP-11_f_jegmhI78UD0daKz7M5qdn-rThuVzqeSf9_6obM0un2PW-2AJ8xKqolwkIw2
responses:
'200':
description: Free text deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Free text deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/free_text/{master_free_text_id}/aliases:
get:
tags:
- Free Text
summary: RESTfulFreeText_GetAliases
description: Gets the collection of free text objct aliases.
operationId: RESTfulFreeText_GetAliases
parameters:
- name: master_free_text_id
in: path
description: Id of a free text object to get aliases for.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Free Text
summary: PostRESTfulFreeText_Post
description: "
Use this format for new free text object creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000001\"\r\n }\r\n }"
operationId: PostRESTfulFreeText_Post
parameters:
- name: master_free_text_id
in: path
description: Master free text id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: tFu1nqNlwrNgBb_3x61b2K9CqdQbzh_DqiXpgigZU1EDi5AJkSH22L9XDfccgdNaz_jHdWMZvBsVga19Gxhy3ofFi6Y5jfuU6HZBsGJb1e3DorMqeiYTCVxbJXvakesOr83mnXSbsk5LqO9dl-CoJg2
requestBody:
description: New free text alias.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.FreeText'
- description: New free text alias.
required: true
responses:
'201':
description: Fre etext creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new free text object should not contain 'href'.
headers: {}
content: {}
'500':
description: Free text object creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/groups:
get:
tags:
- User Groups
summary: RESTfulGroups_Get
description: Gets the user groups collection.
operationId: RESTfulGroups_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- User Groups
summary: RESTfulGroups_Put
description: "System groups cannot be updated. A non-system group cannot be changed to a system\r\n group.\r\nWhen altering the Name parameter (renaming the group) the new name must be\r\n unique throughout groups.\r\n
Use this group format for group update:\r\n \r\n {\r\n \"name\": \"My Group\",\r\n \"system\": false,\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n }"
operationId: RESTfulGroups_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: KP8DiLICamB_sMvCBUkmDVvsxC5FlO8WQMsvzIasAASY7AutiV3tb8FFLZBrSxATw0w2brWaZY6NJMr-jl04IgVlWLarz-9OAwYSPRNzV2J4IjvsCjTex5h2fR8RaXQW0upBiPMwHgBT8Z1DD4njFg2
requestBody:
description: Updated user group.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Group'
- description: Updated user group.
required: true
responses:
'200':
description: User group update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The group or the new group's role cannot be found.
headers: {}
content: {}
'500':
description: User group update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- User Groups
summary: RESTfulGroups_Post
description: "Use this group format for new groups creation:\r\n \r\n {\r\n \"name\": \"New Group Example\",\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n }"
operationId: RESTfulGroups_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 5JCU_gmqdOCRvBliEGYmALQgkA_yjXvo6XxA0RI9jznRSCAbrNDhuC9U2e4mHm38Jj_vSUJ4tYn0JVItSNsFvT0ocilXutkr9R2__THwG3RkyKnxm5FG5ZS7bKzi7l4NBpC_E8ff4gb93zBJ8SaH0A2
requestBody:
description: New user group.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Group'
- description: New user group.
required: true
responses:
'201':
description: User group creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new user group should not contain 'href'.
headers: {}
content: {}
'500':
description: User group creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/groups/{id}:
get:
tags:
- User Groups
summary: RESTfulGroups_GetById
description: 'User group id example: 12000000000003'
operationId: RESTfulGroups_GetById
parameters:
- name: id
in: path
description: User group id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing user group.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Group'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Group'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- User Groups
summary: PutRESTfulGroups_Put
description: "System groups cannot be updated. A non-system group cannot be changed to a system\r\n group.\r\nWhen altering the Name parameter (renaming the group) the new name must be\r\n unique throughout groups.\r\n
Use this group format for group update:\r\n \r\n {\r\n \"name\": \"My Group\",\r\n \"system\": false,\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n }"
operationId: PutRESTfulGroups_Put
parameters:
- name: id
in: path
description: User group id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ks-Il-dZK398FkZBOvjlhwy2WGa182mquX1QHjQvGj2rhFGHxlLVpFlp_u9a5z86Oky9brWgv21AlvlMDej8O8xagFjlHojoFZMrj0-zWkL0nEzny7pi9EFJ1L9Yhk6QuvXhJjU0PnXff5EE7_Bhrg2
requestBody:
description: Updated user group.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Group'
- description: Updated user group.
required: true
responses:
'200':
description: User group update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The group or the new group's role cannot be found.
headers: {}
content: {}
'500':
description: User group update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- User Groups
summary: RESTfulGroups_Delete
description: >-
User group id example: 12000000000003.
Only a non-system user group can be deleted.
A user group with users cannot be deleted.
operationId: RESTfulGroups_Delete
parameters:
- name: id
in: path
description: User group id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ok5rNk-L78jJJSnLgf89zyAb6A4tlO9uUts7_TMNLu6oYKxBnJf-tmGJ7q8L2ZC31G9o8ltDWMAswlBjvKUjtaQDWSnrYsmfkTwOKCeLNRZ3llzt7yHvIK6rDMdN2W0HflYqng-26pOLmFejbRe6lQ2
responses:
'200':
description: User group deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: User group deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/hierarchy:
get:
tags:
- Nodes / Hierarchy
summary: RESTfulHierarchy_Get
description: Gets the hierarchy.
operationId: RESTfulHierarchy_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/hierarchy/{id}:
get:
tags:
- Nodes / Hierarchy
summary: RESTfulHierarchy_GetById
description: Gets the hierarchy starting from the root element.
operationId: RESTfulHierarchy_GetById
parameters:
- name: id
in: path
description: Id of the root node of the hierarchy.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/import/device_type_query:
post:
tags:
- Import / Device Type Query
summary: RESTfulDeviceQueryImport_ImportDeviceQuery
description: "Use this C# code example as a reference for your client application:\r\n \r\n public static void ImportDeviceQuery(string zipFileFullPath)\r\n {\r\n // Create the query request with RestSharp API client library.\r\n // (see https://restsharp.dev/).\r\n \r\n var request = new RestRequest(\"import/device_type_query\", Method.POST);\r\n \r\n // Add file content for upload.\r\n request.AddFileBytes(\"file\", File.ReadAllBytes(zipFileFullPath),\r\n Path.GetFileName(zipFileFullPath), \"application/octet-stream\");\r\n \r\n // Add authentication.\r\n request.AddHeader(\"Authorization\", \"Bearer XXXXXXXXXXXXXXX...\");\r\n \r\n // Execute the request. You need to use a real SSL-protected url.\r\n var response = new RestClient(\"http://localhost/NetTerrain/wapi/v1\").Execute(request);\r\n \r\n if (response.ResponseStatus == ResponseStatus.Completed)\r\n {\r\n // Output the import log returned as a plain text with the successful response.\r\n Console.Write(response.Content.ToString().Replace(@\"\\r\\n\", Environment.NewLine));\r\n }\r\n else\r\n {\r\n // Process error.\r\n }\r\n }"
operationId: RESTfulDeviceQueryImport_ImportDeviceQuery
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: HPu720U1dHQB3jNESqcozVQ2HZ7nCjrYmTQ6NbHhmbyUmWlSk5qFp-ciIJUjqtMhBiybFxuYg5XmJ7vaSTdg1krpGcyoBe9gso4dC4xaIdEziX2vL8WxhjBcxaQr3vq3Vo9aCEN-HIT8A31Y5d9JGg2
responses:
'200':
description: Import successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'415':
description: Invalid request media type.
headers: {}
content: {}
'500':
description: Import failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_categories:
get:
tags:
- Link Categories
summary: RESTfulLinkCategories_Get
description: Gets the link categories collection.
operationId: RESTfulLinkCategories_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Link Categories
summary: RESTfulLinkCategories_Put
description: "When altering the name parameter (renaming the link category) the new name must\r\n be unique throughout all link categories.\r\n\r\n
When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image.\r\n
Use this link categories format for link category update:\r\n \r\n {\r\n \"name\": \"My category\",\r\n \"is_favorite\": true,\r\n \"parent_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_categories/32000000000001\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_categories/32000000000002\"\r\n }"
operationId: RESTfulLinkCategories_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: nJXm5DiD6nk6BXQdJZ73KuGyNQe24rDmwFfA70pIh8QPfn4O5tO9K3QY049DL80WLLgIQTi6AulNUfy6S9o69jycJ-GQRSgZcvX-y0Jo0sh-D8JwtSJz2uTMMIjQXUohCBkkp-BKLd55_7WoNJfdJQ2
requestBody:
description: Updated link category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkCategory'
- description: Updated link category.
required: true
responses:
'200':
description: Link category update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link category cannot be found.
headers: {}
content: {}
'500':
description: Link category update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Link Categories
summary: RESTfulLinkCategories_Post
description: "Use this link category format for new link categories creation:\r\n \r\n {\r\n \"name\": \"New category\",\r\n \"is_favorite\": true,\r\n \"parent_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_categories/32000000000001\"\r\n }\r\n }"
operationId: RESTfulLinkCategories_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: mrnFQ7WO6W5iJ6YSUQwxkZNAsT_p_mZ3wDLjFvVURWyqvFYcXjHiUlGiQydie8t-aEnUQraqfZn2FOevN5jAyWWEERpeHGa1qKbedZ59viUmSBCsdVL2RxHmRuJL_3bT_Mg2AVf3ORKL-3eLSd-D1A2
requestBody:
description: New link category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkCategory'
- description: New link category.
required: true
responses:
'201':
description: Link category creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link category should not contain 'href'.
headers: {}
content: {}
'500':
description: Link category creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_categories/{id}:
get:
tags:
- Link Categories
summary: RESTfulLinkCategories_GetById
description: 'Link category id example: 32000000000002'
operationId: RESTfulLinkCategories_GetById
parameters:
- name: id
in: path
description: Link category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link category.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkCategory'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkCategory'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Link Categories
summary: PutRESTfulLinkCategories_Put
description: "When altering the name parameter (renaming the link category) the new name must\r\n be unique throughout all link categories.\r\n\r\n
When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image.\r\n
Use this link categories format for link category update:\r\n \r\n {\r\n \"name\": \"My category\",\r\n \"is_favorite\": true,\r\n \"parent_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_categories/32000000000001\"\r\n },\r\n }"
operationId: PutRESTfulLinkCategories_Put
parameters:
- name: id
in: path
description: Link category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 7Xz6FD1wJq4-qQJnnhT4JxIL4Zp-bFiGKHxK2XwQZRkeSOqD6yyrF28D7e7QsSsVba59gpWU2fLtiJxAk-CRayBPglJ2UabRIk6VK35bwifQTWcHpY-7QkF3nPbLDHkPQ9sXu_GUlZ5KmCXFXknaSg2
requestBody:
description: Updated link category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkCategory'
- description: Updated link category.
required: true
responses:
'200':
description: Link category update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link category cannot be found.
headers: {}
content: {}
'500':
description: Link category update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Link Categories
summary: RESTfulLinkCategories_Delete
description: Link categories in use cannot be deleted.
operationId: RESTfulLinkCategories_Delete
parameters:
- name: id
in: path
description: Link category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: TNgvYZ1S9hf4zqj86eQdA_xv1PLQRS750AjP7dxfvWmQQfg7GQYqaHXmI_7h9CY8Eus3R8T23owL45BMXvfrOoT_kNxiArH2hoZCsZfB4uUblW4Id3hP1zgBO84hjkul5yuD6gqDKJ9wE7DVkSYCSw2
responses:
'200':
description: Link category deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Link category deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_overrides:
get:
tags:
- Link Types / Properties / Overrides
summary: RESTfulLinkOverrides_Get
description: Gets the general link overrides collection.
operationId: RESTfulLinkOverrides_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Link Types / Properties / Overrides
summary: RESTfulLinkOverrides_Put
description: "As the general link overrides endpoint is used the updated resource is identified by\r\n its 'href' in the body.\r\n'parent_link_type_property' cannot be changed.\r\nBy altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false).\r\n
Use this link categories format for link override update:\r\n \r\n {\r\n \"parent_link_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi/v1/link_types/27000000000008/link_type_properties/29000000175500\"\r\n },\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#000000\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000008/link_type_properties/29000000175500/link_overrides/35\"\r\n }"
operationId: RESTfulLinkOverrides_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 3PiqQ5lkdeqbZUp5hy4IOxsWYYK_fWUEKkgQIy0_au0aH32hirkSjMUFP8A_M3v9n02DhbKCbW4jWsbv-wbTegK_WF6CXXX9r997oxtNI7uWR0BD5lERKItdlbIC9dqNx5oPTulxyGjFB6LCi4uaAw2
requestBody:
description: Updated link override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
- description: Updated link override.
required: true
responses:
'200':
description: Link override update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link override cannot be found.
headers: {}
content: {}
'500':
description: Link override update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Link Types / Properties / Overrides
summary: RESTfulLinkOverrides_Post
description: "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything.\r\n
Use this link override format for new link overrides creation:\r\n \r\n {\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#000000\",\r\n \"parent_link_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000100\"\r\n }\r\n }"
operationId: RESTfulLinkOverrides_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: YUYoOIJpx8Ndn5QTvNHuMU1tuUbt1yAlPR0-51f_ZBe8gvYtUax9JdRdgDXOnrpptSWsO8BI_GZZsqlrMn_aSMT2_ByfE1rQlKHIPRrLh-FH3k7afd-qhXFuyyReW_jALJxz-gF1d67uNazkfx8GEw2
requestBody:
description: New link override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
- description: New link override.
required: true
responses:
'201':
description: Link override creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link override should not contain 'href'.
headers: {}
content: {}
'500':
description: Link override creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_overrides/{id}:
get:
tags:
- Link Types / Properties / Overrides
summary: RESTfulLinkOverrides_GetById
description: 'Link override id example: 5'
operationId: RESTfulLinkOverrides_GetById
parameters:
- name: id
in: path
description: Link override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_type_properties/{link_type_property_id}/link_overrides:
get:
tags:
- Link Types / Properties / Overrides
summary: GetRESTfulLinkOverrides_Get
description: Gets the link overrides collection for a property.
operationId: GetRESTfulLinkOverrides_Get
parameters:
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/link_type_properties/{link_type_property_id}/link_overrides/{id}:
get:
tags:
- Link Types / Properties / Overrides
summary: GetRESTfulLinkOverrides_GetById
description: 'Link override id example: 5'
operationId: GetRESTfulLinkOverrides_GetById
parameters:
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Link override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types/{link_type_id}/link_type_properties/{link_type_property_id}/link_overrides:
get:
tags:
- Link Types / Properties / Overrides
summary: GetRESTfulLinkOverrides_Get1
description: Gets the link overrides collection for a property.
operationId: GetRESTfulLinkOverrides_Get1
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Link Types / Properties / Overrides
summary: PostRESTfulLinkOverrides_Post
description: "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything.\r\nLink that you don't need to specify 'parent_link_type_property' reference\r\n as it is already set by the endpoint Url.\r\n
Use this link override format for new link overrides creation:\r\n \r\n {\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#000000\"\r\n }"
operationId: PostRESTfulLinkOverrides_Post
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: GmCujQLAcL8cEPMGl576i1GhUPFnGhnviF-qCtksm5EatBbWlCP1G9o_rxMxwX1g5xeVTymDvGquDpiuHhsC3OT9m7B4mM3U7bOO_bW2D1cb7dWLo4xTioR68xT7y8lW2Mt3SR7Lrp-KqkmvrEaLCw2
requestBody:
description: New link override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
- description: New link override.
required: true
responses:
'201':
description: Link override creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link override should not contain 'href'.
headers: {}
content: {}
'500':
description: Link override creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types/{link_type_id}/link_type_properties/{link_type_property_id}/link_overrides/{id}:
get:
tags:
- Link Types / Properties / Overrides
summary: GetRESTfulLinkOverrides_GetById1
description: 'Link override id example: 5'
operationId: GetRESTfulLinkOverrides_GetById1
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Link override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Link Types / Properties / Overrides
summary: PutRESTfulLinkOverrides_Put
description: "This update method is triggered by sending PUT request directly to the resource's\r\n 'href' url. For data consistency verification 'href' (if presents) must be the same as the\r\n request url.\r\n'parent_link_type_property' cannot be changed.\r\nBy altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false).\r\n
\r\n
Use this link categories format for link override update:\r\n \r\n {\r\n \"parent_link_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi/v1/link_types/27000000000008/link_type_properties/29000000175500\"\r\n },\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#000000\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000008/link_type_properties/29000000175500/link_overrides/35\"\r\n }"
operationId: PutRESTfulLinkOverrides_Put
parameters:
- name: id
in: path
description: Link override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_property_id
in: path
description: Parent link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: EdZNB-dJsyxER2gOUJvdTL61ttGGT7NM8jeGEiTAs-8oFitTW9W5Uiv-RBK-IRzGdiSRx3wF-m2geWkYwBWdBO_8CKhEbbPxzKS22Snpc0mOgy3jhWsrBDcUdPouYlzbqXMBwCDx4YIXSNetkUuEZA2
requestBody:
description: Updated link override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkOverride'
- description: Updated link override.
required: true
responses:
'200':
description: Link override update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link override cannot be found.
headers: {}
content: {}
'500':
description: Link override update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Link Types / Properties / Overrides
summary: RESTfulLinkOverrides_Delete
description: Deletes a link override.
operationId: RESTfulLinkOverrides_Delete
parameters:
- name: id
in: path
description: Link override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: link_type_property_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: zIxTwpBKscFmzUBSrSyxHbjnBzXC-vhPdw1c4zfOxqQ-ZLz7dU0lxn1tHLfSuIGZ8z-bVZsQX37G4Dz2epL9UjV8-DMvsnCtOEpfvV7DsvqxgUlvC-o1NuTjrjv9SJ5-jH8bjY4VwM-5Px6FZKMg2g2
responses:
'200':
description: Link override deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Link override deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_property_values:
get:
tags:
- Links / Property Values
summary: RESTfulLinkPropertyValues_Get
description: >-
This collection is useful when direct access to link property values is required.
For example, to search a property by its name and value when a parent link is unknown.
operationId: RESTfulLinkPropertyValues_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Links / Property Values
summary: RESTfulLinkPropertyValues_Put
description: "'Type' property value cannot be updated.\r\nLink property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a link in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/Links/25000000010516/link_property_values/7334\"\r\n }\r\n \r\n Use the following format if you know the link property value's name:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"name\": \"Status\",\r\n \"parent_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000010516\"\r\n }\r\n }\r\n \r\n Use the following format if you know the link property value's parent property:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"link_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000456\"\r\n },\r\n \"parent_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/24000000010516\"\r\n }\r\n }\r\n \r\n For multiple property values update (batch update) use an array of properties,\r\n each property may use any available format (the response will contain an array of errors\r\n for unsuccessfully updated property values from the array):\r\n \r\n [{\r\n \"link_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000456\"\r\n },\r\n \"parent_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/29000000002692\"\r\n },\r\n \"value\": \"Cable\"\r\n },\r\n {\r\n \"name\": \"Status\",\r\n \"parent_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/29000000002692\"\r\n },\r\n \"value\": \"new\",\r\n }]"
operationId: RESTfulLinkPropertyValues_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ZvjDFVaj6jmkGelzYFlNSuPXKTuz9nHOLpuWGSiOft8xzYLY6iu4tzWAfE_VI9m7ejG4OVS6C_TiBNtwbC9LsaadUrQaNPbI6zg8umuTcizqt-ApxvPTuC0CUZRy4Am1VBfCOhItC0PNJjamjLv7bA2
requestBody:
description: Updated link property value. Or values array.
content:
application/json:
schema:
type: object
description: Updated link property value. Or values array.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_property_values/{id}:
get:
tags:
- Links / Property Values
summary: RESTfulLinkPropertyValues_GetById
description: 'Link id format: 25000000000123, Link property value id format: 123456.'
operationId: RESTfulLinkPropertyValues_GetById
parameters:
- name: id
in: path
description: Link property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{link_id}/link_property_values:
get:
tags:
- Links / Property Values
summary: GetRESTfulLinkPropertyValues_Get
description: Gets the link property values collection.
operationId: GetRESTfulLinkPropertyValues_Get
parameters:
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Links / Property Values
summary: PutRESTfulLinkPropertyValues_Put
description: "'Type' property value cannot be updated.\r\nLink property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a link in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000010516/link_property_values/7334\"\r\n }\r\n \r\n Use the following format if you know the link property value's name:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"name\": \"Status\"\r\n }\r\n \r\n Use the following format if you know the link property value's parent property:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"link_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000456\"\r\n }\r\n }"
operationId: PutRESTfulLinkPropertyValues_Put
parameters:
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: wDfavMq2GAo8pT444QG6O80ofGq_1K1yPXfod7tRq4ofW6lh-whC05_ue2w5TxGaJtbNZNyFkek8Yva_SOPdkNgO2QqgILXlT7_kF28GTAE7I_UDoga6XZsWUv0pQPWiStlXlO5VS8FOohoptjtN7w2
requestBody:
description: Updated link property value id.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
- description: Updated link property value id.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{link_id}/link_property_values/{id}:
get:
tags:
- Links / Property Values
summary: GetRESTfulLinkPropertyValues_GetById
description: 'Link id format: 25000000000123, Link property value id format: 123456.'
operationId: GetRESTfulLinkPropertyValues_GetById
parameters:
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Link property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Links / Property Values
summary: PutRESTfulLinkPropertyValues_Put1
description: "'Type' property value cannot be updated.\r\nLink property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a link in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\"\r\n }"
operationId: PutRESTfulLinkPropertyValues_Put1
parameters:
- name: id
in: path
description: Link property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: TWYW4Gn5Fd6qwSX86MEzbjkDWfGUXU65ajyqCdhlPGnMVW-dPfjDw8HJckLmSjelu0JV-3tqkmZUtnLS3fttaaDWvTdS6eDjAie5xKHMxJ21ZJK4C5NHLUvTFyMtYpE7lOUe78IljcwfwD2q11UISg2
requestBody:
description: Updated link property value id.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkPropertyValue'
- description: Updated link property value id.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{link_id}/link_property_values/init_absent_values:
post:
tags:
- Links / Property Values
summary: RESTfulLinkPropertyValues_InitAbsentValues
description: >-
All created link property values will be empty and 'Type' property value will
contain a link type name.
operationId: RESTfulLinkPropertyValues_InitAbsentValues
parameters:
- name: link_id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 9eDjnKuLPJzDFs7Dv3quNWjCh5pSjFMCOmrV-TmY-AcB6VO1tMnerQY4yG02gt7jQnbmsshHq4wSBoqq0iT5F2E07ILgioA8mgwGfpDoQY8pfUPKI-qcrCLmoNf7C9HfE27eG6auhsvHC9mukPjuoQ2
responses:
'200':
description: All link property values has already been created before.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'201':
description: Link property values were successfully created.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'404':
description: The link does not exist.
headers: {}
content: {}
'500':
description: Link property values creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_type_properties:
get:
tags:
- Link Types / Properties
summary: RESTfulLinkTypeProperties_Get
description: Gets the link type properties collection with no relation to a specific link type.
operationId: RESTfulLinkTypeProperties_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Link Types / Properties
summary: RESTfulLinkTypeProperties_Put
description: "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this link type properties format for link override update:\r\n \r\n {\r\n \"name\": \"MyProperty\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"type_field\": true,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000094\"\r\n }\r\n \r\n For multiple properties update (batch update) use an array of properties,\r\n the response will contain an array of errors for unsuccessfully updated properties\r\n from the array:\r\n \r\n [{\r\n \"default_value\": \"20\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000002667/link_type_properties/29000000003733\"\r\n },\r\n {\r\n \"default_value\": \"0\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000002667/link_type_properties/29000000003734\"\r\n }]"
operationId: RESTfulLinkTypeProperties_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Qu80JRgQw87UH-BSN2Pvrbh-_RkmCWzaRyeHIQEHbMR5NfpAtHD_haWWB3SHfXAPUZdXrFEf2TvFlxUJbFn4qAZP1TRsdiuth-dfavb7oQjTdX5Uu2FcrLXaeC322ysCpKUWeWQlQnEE0uj8AxZyrw2
requestBody:
description: Updated link type property. Or properties array.
content:
application/json:
schema:
type: object
description: Updated link type property. Or properties array.
required: true
responses:
'200':
description: Link type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link type property cannot be found.
headers: {}
content: {}
'500':
description: Link type property update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Link Types / Properties
summary: RESTfulLinkTypeProperties_Post
description: "
Use this link type property format for link type property update:\r\n \r\n {\r\n \"name\": \"Type\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"type_field\": true,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"parent_link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n }\r\n }"
operationId: RESTfulLinkTypeProperties_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: nmXPrqRWYu3W-Akl0f3SHloTN5_bJeJ33DDWJG0eWamZz79aYv91a6hXBTvxFP9cgbu8SvCCwAHVmi7bLou34WXcA7Lfkm7TKKwJs28WkmDx_GjhG7D-pno9Cx-HDyA4boI8ANCCnTGCesmcwBvlZQ2
requestBody:
description: New link type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
- description: New link type property.
required: true
responses:
'201':
description: Link type property creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link type property should not contain 'href'.
headers: {}
content: {}
'500':
description: Link type property creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_type_properties/{id}:
get:
tags:
- Link Types / Properties
summary: RESTfulLinkTypeProperties_GetById
description: 'Link type property id example: 28000000000076'
operationId: RESTfulLinkTypeProperties_GetById
parameters:
- name: id
in: path
description: Link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link type property.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types/{link_type_id}/link_type_properties:
get:
tags:
- Link Types / Properties
summary: GetRESTfulLinkTypeProperties_Get
description: Gets the link type properties collection.
operationId: GetRESTfulLinkTypeProperties_Get
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Link Types / Properties
summary: PutRESTfulLinkTypeProperties_Put
description: "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this link type properties format for link override update:\r\n \r\n {\r\n \"name\": \"MyProperty\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"type_field\": true,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123/link_type_properties/29000000000094\"\r\n }"
operationId: PutRESTfulLinkTypeProperties_Put
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: cOvlvjbwgLhQABfrzPj7np2XsefATRMHQmCVx9heNyYy5crJy61UtyVH51QQw44kZb6b-Zw1-TNFdkuACl_FOSgajp52FEgC9k983JkI1ytUOCMTU_dE28KZe8teoBG8qvoSEMkkaoXjJ34uDNjG3g2
requestBody:
description: Updated link type property.
content:
application/json:
schema:
type: object
description: Updated link type property.
required: true
responses:
'200':
description: Link type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link type property cannot be found.
headers: {}
content: {}
'500':
description: Link type property update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Link Types / Properties
summary: PostRESTfulLinkTypeProperties_Post
description: "
Use this link type property format for link type property update:\r\n \r\n {\r\n \"name\": \"Type\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"type_field\": true,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"parent_link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n }\r\n }"
operationId: PostRESTfulLinkTypeProperties_Post
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: eG9GHpznp_I577wm8_edF5WR0T-0sQFojB5bJMyIA-8TvJ47ifGdLBU0XfVR2Rbn7QfmgzR9jrKM4iWsf78fYzxyLXqbUVkac2jzrjSYobsxKv1ETTtDEX2AI-nGaCKWUxwPNzOwZzsPVVw_lnt2iA2
requestBody:
description: New link type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
- description: New link type property.
required: true
responses:
'201':
description: Link type property creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link type property should not contain 'href'.
headers: {}
content: {}
'500':
description: Link type property creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types/{link_type_id}/link_type_properties/{id}:
get:
tags:
- Link Types / Properties
summary: GetRESTfulLinkTypeProperties_GetById
description: 'Link type property id example: 29000000000076'
operationId: GetRESTfulLinkTypeProperties_GetById
parameters:
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link type property.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Link Types / Properties
summary: PutRESTfulLinkTypeProperties_Put1
description: "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this link type properties format for link override update:\r\n \r\n {\r\n \"name\": \"MyProperty\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"type_field\": true,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false\r\n }"
operationId: PutRESTfulLinkTypeProperties_Put1
parameters:
- name: id
in: path
description: Link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_id
in: path
description: Parent link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: xJcW0Fcu4691_E5HEzGzB7KNrQkpGV1iJ82POlMAy9vUHMdLHD3RJExfJIppXj87rVjSpi-tWfAwqFGa8wfDCZY31s-LJ4AZlt-kk5GIFBkMYLFwc9sRPWc4cczRV5jiw_fF8SaDQ29a8L9ioGYHXQ2
requestBody:
description: Updated link type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkTypeProperty'
- description: Updated link type property.
required: true
responses:
'200':
description: Link type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link type property cannot be found.
headers: {}
content: {}
'500':
description: Link type property update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Link Types / Properties
summary: RESTfulLinkTypeProperties_Delete
description: Only non-system link type properties can be deleted.
operationId: RESTfulLinkTypeProperties_Delete
parameters:
- name: id
in: path
description: Link type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: link_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: JVrgpt97oJn888TEUB40xRaeczh4n9E6fTwDgvt99QZ9HkTD58OrsObr8VV9M9TeZfoGpGf85Pah0TGkuoDbpzIvPyLO0KSriLxTxbhexMgsGE3TenW8z3afl29OJtm7LhIts4cVMLXekNWFu5nUiQ2
responses:
'200':
description: Link type property deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Link type property deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types:
get:
tags:
- Link Types
summary: RESTfulLinkTypes_Get
description: Gets the link types collection.
operationId: RESTfulLinkTypes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Link Types
summary: RESTfulLinkTypes_Put
description: "System link types cannot be updated. The system parameter cannot be altered\r\n either.\r\n\r\n
When altering the name parameter (renaming the link type) the new name\r\n must be unique.\r\n\r\n
A favorite link type or a link type with existing link instances cannot be\r\n disabled.\r\n
Use this link type format for link override update:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"is_snapped_to_edge\": false,\r\n \"is_matching_port_connectors\": false,\r\n \"thickness\": 2,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#800000\",\r\n \"link_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n }"
operationId: RESTfulLinkTypes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: DITSoCTSaXYyrQCQGIDTInfIqhGPkdmyoM0oWbEAfCqpCj8vCJ3TxKnvhPV1qz_5GQCCxNZhFY7jzzAcLzPuEFDUwYbHq2W7xt2lhDo5Hx-wwHy9VSsLDXH4uaYOAJiPZy8UU7eBkgL9iMwLvOpkwg2
requestBody:
description: Updated link type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkType'
- description: Updated link type.
required: true
responses:
'200':
description: Link type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link type cannot be found.
headers: {}
content: {}
'500':
description: Link type update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Link Types
summary: RESTfulLinkTypes_Post
description: "
Use this link types format for link type create:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"is_snapped_to_edge\": false,\r\n \"is_matching_port_connectors\": false,\r\n \"thickness\": 2,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#800000\",\r\n \"link_category\": null\r\n }"
operationId: RESTfulLinkTypes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: iunVNgqvDxci9UkejVVlChMkwIJKXq97oW4HN2bQ7NaAWmNYXGSqCn1QT7bmzyDdnR5UMt1fbryNT5YWtNOU0MuWsGPugd8jH8Q6FWYoWTVAZRW9lOrpVSAecdQM4eC8bp8mOoyk-WDiky18DLipaQ2
requestBody:
description: New link type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkType'
- description: New link type.
required: true
responses:
'201':
description: Link type creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new link type should not contain 'href'.
headers: {}
content: {}
'500':
description: Link type creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/link_types/{id}:
get:
tags:
- Link Types
summary: RESTfulLinkTypes_GetById
description: 'Link type id example: 27000000000017'
operationId: RESTfulLinkTypes_GetById
parameters:
- name: id
in: path
description: Link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkType'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkType'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Link Types
summary: PutRESTfulLinkTypes_Put
description: "System link types cannot be updated. The system parameter cannot be altered\r\n either.\r\n\r\n
When altering the name parameter (renaming the link type) the new name\r\n must be unique.\r\n\r\n
A favorite link type or a link type with existing link instances cannot be\r\n disabled.\r\n
Use this link type format for link override update:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"is_snapped_to_edge\": false,\r\n \"is_matching_port_connectors\": false,\r\n \"thickness\": 2,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#800000\",\r\n \"link_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n }"
operationId: PutRESTfulLinkTypes_Put
parameters:
- name: id
in: path
description: Link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 5ys6HzOG9jYjvIQvwgxae1jNv3FiNkOHIjNvBRfhCRoAp9ZN3ASxC0F4Xf0hTDw8ijTzfLv_aqADJKKRUo6YL3lYEJD-yBYtuyTyaRCXao26FbjPeoyd9-2wgSF6Rdru9UkPs0-GoheabTBlFS5QVg2
requestBody:
description: Updated link type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkType'
- description: Updated link type.
required: true
responses:
'200':
description: Link type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The link type cannot be found.
headers: {}
content: {}
'500':
description: Link type update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Link Types
summary: RESTfulLinkTypes_Delete
description: Only non-system link types without associated links can be deleted.
operationId: RESTfulLinkTypes_Delete
parameters:
- name: id
in: path
description: Link type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: _el57H_ejC-P25OmD1--WU3GH1LedQORqBTBh3phsf9WMI2NN-quFCKoE4wDTVOBYeqzvkNp1oq2tbzmmjdxQNs1SdRqLF-t5rD6Zp6hL-cXmQRxIQG-Qrlzw7Bw59PTFIqo2AmvfRUVLae4WpEsdg2
responses:
'200':
description: Link type deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Link type deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{link_id}/vis_links:
get:
tags:
- Links / Vis Links
summary: RESTfulVisLinks_Get
description: Gets the vis links collection.
operationId: RESTfulVisLinks_Get
parameters:
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Links / Vis Links
summary: RESTfulVisLinks_Put
description: "
Use this format for vis link update:\r\n \r\n {\r\n \"is_curved\": false,\r\n \"bend_points_path\": \"\",\r\n \"from_anchor_point_x\": 0.5,\r\n \"from_anchor_point_y\": 0.5,\r\n \"to_anchor_point_x\": 0.5,\r\n \"to_anchor_point_y\": 0.5,\r\n \"can_move\": true,\r\n \"can_delete\": true,\r\n \"is_hidden\": false,\r\n \"is_snapped_to_edge\": false,\r\n \"z_order\": 0,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000000047/vis_links/62\"\r\n }"
operationId: RESTfulVisLinks_Put
parameters:
- name: link_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: -7q39jVFl9ckoppoyhmS6WuYHF8bkNhbrWOOjHL-vFrXhMHgZyiIEnwwWbU8EFqsbLMnU_FvDpoxxsQm7ioBHp-19shLyqM80q5f0Ha9Tl8Kq3P2wTO9NWB8EchOMfxZWhcF0ZGSFAfjcmr5Ce9-Xg2
requestBody:
description: Updated vis link.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisLink'
- description: Updated vis link.
required: true
responses:
'200':
description: Vis link update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The vis link cannot be found.
headers: {}
content: {}
'500':
description: Vis link update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/links/{link_id}/vis_links/{id}:
get:
tags:
- Links / Vis Links
summary: RESTfulVisLinks_GetById
description: 'Link id example: 25000000000123, Vis Link id example: 123'
operationId: RESTfulVisLinks_GetById
parameters:
- name: link_id
in: path
description: Parent link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Vis Link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing vis link.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisLink'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisLink'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_categories:
get:
tags:
- Node Categories
summary: RESTfulNodeCategories_Get
description: Gets the node categories collection.
operationId: RESTfulNodeCategories_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Categories
summary: RESTfulNodeCategories_Put
description: "When altering the name parameter (renaming the node category) the new name must\r\n be unique throughout all node categories.\r\n\r\n
When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image.\r\nThe type group of the node category cannot be changed.\r\nTo set or alter the parent parameter (reparenting) the node type\r\n group of the new parent node category must coincide with this node category.\r\n
Use this node categories format for node category update:\r\n \r\n {\r\n \"name\": \"Transportation\",\r\n \"image\": \"beta_accounting_truck_256.png\",\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"parent_node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000004\"\r\n }"
operationId: RESTfulNodeCategories_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Fe54y9orlL_GUISqHaXEK9rdKGAlh5D69wsYNIz7AdJXAAWi9jylZC2bxh2IQ7t6_P78WLzF9eiqm690fFi29o1BthP32AT2EnD6eH__xz8RqXt9z21OrK508yAV0SSb71SRzeU9xCBWWXhlnlcPNg2
requestBody:
description: Updated node category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeCategory'
- description: Updated node category.
required: true
responses:
'200':
description: Node category update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node category cannot be found.
headers: {}
content: {}
'500':
description: Node category update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Categories
summary: RESTfulNodeCategories_Post
description: "Use this node category format for new node categories creation:\r\n \r\n {\r\n \"name\": \"New category\",\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"parent_node_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000003\"\r\n }\r\n }"
operationId: RESTfulNodeCategories_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: vdzwwe2a8uQiSU-9q-9JEzGIiTfmaPB_r1m0NWoJYqXEW8Y1oDqwGO2NSc4ZNoWPZ8OIMFUC-m53qdSjomxmWRP9m0vBBZrnL_lWN93UfUoo2QL3Zur9sMjTovKUZRgZPuHBTtvpNQKBDlULydSorw2
requestBody:
description: New node category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeCategory'
- description: New node category.
required: true
responses:
'201':
description: Node category creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node category should not contain 'href'.
headers: {}
content: {}
'500':
description: Node category creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_categories/{id}:
get:
tags:
- Node Categories
summary: RESTfulNodeCategories_GetById
description: 'Node category id example: 31000000000004'
operationId: RESTfulNodeCategories_GetById
parameters:
- name: id
in: path
description: Node category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node category.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeCategory'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeCategory'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Categories
summary: PutRESTfulNodeCategories_Put
description: "When altering the name parameter (renaming the node category) the new name must\r\n be unique throughout all node categories.\r\n\r\n
When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image.\r\nThe type group of the node category cannot be changed.\r\nTo set or alter the parent parameter (reparenting) the node type\r\n group of the new parent node category must coincide with this node category.\r\n
Use this node categories format for node category update:\r\n \r\n {\r\n \"name\": \"Transportation\",\r\n \"image\": \"beta_accounting_truck_256.png\",\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"parent_node_category\": null\r\n }"
operationId: PutRESTfulNodeCategories_Put
parameters:
- name: id
in: path
description: Node category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: UvzddkMhxMZIETNkwher1oDervYYyySIbamnB2ywh8pmUhhBmM1qk4NjWRfwp8SzPblVqi68o04LfCENNI0XUhTfM8_Fen6bEKZhyUwZJULQYKbS5HoUYllsfaoKD5nXlp47GiGOcXasu8iItZntsg2
requestBody:
description: Updated node category.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeCategory'
- description: Updated node category.
required: true
responses:
'200':
description: Node category update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node category cannot be found.
headers: {}
content: {}
'500':
description: Node category update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Categories
summary: RESTfulNodeCategories_Delete
description: Node categories in use cannot be deleted.
operationId: RESTfulNodeCategories_Delete
parameters:
- name: id
in: path
description: Node category id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: xdL14NZP1OgxFXHZQrFbqd8CvMnWBUdJEzcNFWHjD6sJFvqEgH2wcg-Skn9MVujEutSSMiZ3ib-WIzwHBSZipLeJGRlX98UxBX1u5Ac67HFwsJ1n8f0Ts0c3Q1LUKPCArwm9wyITNHFYkeyL14dJIg2
responses:
'200':
description: Node category deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Node category deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_overrides:
get:
tags:
- Node Types / Properties / Overrides
summary: RESTfulNodeOverrides_Get
description: Gets the general node overrides collection.
operationId: RESTfulNodeOverrides_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Properties / Overrides
summary: RESTfulNodeOverrides_Put
description: "As the general node overrides endpoint is used the updated resource is identified by\r\n its 'href' in the body.\r\n'parent_node_type_property' cannot be changed.\r\nBy altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false).\r\n
Use this node categories format for node override update:\r\n \r\n {\r\n \"parent_node_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi/v1/node_types/26000000000008/node_type_properties/28000000175500\"\r\n },\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"image\": \"5ybawbok.jpg\",\r\n \"instance_effect\": \"NoEffect\",\r\n \"parent_effect\": \"NoEffect\",\r\n \"upwards_propagation\": \"NoPropagations\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000008/node_type_properties/28000000175500/node_overrides/35\"\r\n }"
operationId: RESTfulNodeOverrides_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: cXwYc_NOaQogn5mr7l-w5k5TWZIK2KT_0EBWqmu2XBGYlfSQ3r-VYY03OTVCtjowTdQ4Y7dZoGXll5Q9WaOFpZs8wAPdHH_qUGkDqwPf8zSRUDlLcE7lIjWFV1lqTJOcsT94LLt29s1Vac3zoDTy-w2
requestBody:
description: Updated node override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
- description: Updated node override.
required: true
responses:
'200':
description: Node override update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node override cannot be found.
headers: {}
content: {}
'500':
description: Node override update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Properties / Overrides
summary: RESTfulNodeOverrides_Post
description: "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything.\r\n
Use this node override format for new node overrides creation:\r\n \r\n {\r\n \"parent_node_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123/node_type_properties/28000000000123\"\r\n },\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"image\": \"5ybawbok.jpg\",\r\n \"instance_effect\": \"NoEffect\",\r\n \"parent_effect\": \"NoEffect\",\r\n \"upwards_propagation\": \"NoPropagations\"\r\n }"
operationId: RESTfulNodeOverrides_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: lV9CTaIRbWAE6rz4XJv3Wte-awLcMOXCvaUaDgDX32wfhRey6tgokEbmOKjhaENV7nzv-YI9fhKplPxoiee0nvVBwrdBewRGa1WnOUXrbwK8slaYHNlNi3gDxoJCGKZOqLoNNax7QqYbgh8l6jIiDg2
requestBody:
description: New node override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
- description: New node override.
required: true
responses:
'201':
description: Node override creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node override should not contain 'href'.
headers: {}
content: {}
'500':
description: Node override creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_overrides/{id}:
get:
tags:
- Node Types / Properties / Overrides
summary: RESTfulNodeOverrides_GetById
description: 'Node override id example: 5'
operationId: RESTfulNodeOverrides_GetById
parameters:
- name: id
in: path
description: Node override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_type_properties/{node_type_property_id}/node_overrides:
get:
tags:
- Node Types / Properties / Overrides
summary: GetRESTfulNodeOverrides_Get
description: Gets the node overrides collection for a property.
operationId: GetRESTfulNodeOverrides_Get
parameters:
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/node_type_properties/{node_type_property_id}/node_overrides/{id}:
get:
tags:
- Node Types / Properties / Overrides
summary: GetRESTfulNodeOverrides_GetById
description: 'Node override id example: 5'
operationId: GetRESTfulNodeOverrides_GetById
parameters:
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Node override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types/{node_type_id}/node_type_properties/{node_type_property_id}/node_overrides:
get:
tags:
- Node Types / Properties / Overrides
summary: GetRESTfulNodeOverrides_Get1
description: Gets the node overrides collection for a property.
operationId: GetRESTfulNodeOverrides_Get1
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Properties / Overrides
summary: PostRESTfulNodeOverrides_Post
description: "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything.\r\nNode that you don't need to specify 'parent_node_type_property' reference\r\n as it is already set by the endpoint Url.\r\n
Use this node override format for new node overrides creation:\r\n \r\n {\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"image\": \"5ybawbok.jpg\",\r\n \"instance_effect\": \"NoEffect\",\r\n \"parent_effect\": \"NoEffect\",\r\n \"upwards_propagation\": \"NoPropagations\"\r\n }"
operationId: PostRESTfulNodeOverrides_Post
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: r7enpfQxjegYW-MqcSugIPfHOxIxsp6xVNV0lU5T_spkJEskIgdTAfLg8HptS6-Gj0VoY98lNVikhD_1HyZzA-Hrlk6Dfr5U_pMUrIh3x2inwnjbjsoorPO9ybdfcRuvPT8_9fI65_VjzmwJTikkuQ2
requestBody:
description: New node override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
- description: New node override.
required: true
responses:
'201':
description: Node override creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node override should not contain 'href'.
headers: {}
content: {}
'500':
description: Node override creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types/{node_type_id}/node_type_properties/{node_type_property_id}/node_overrides/{id}:
get:
tags:
- Node Types / Properties / Overrides
summary: GetRESTfulNodeOverrides_GetById1
description: 'Node override id example: 5'
operationId: GetRESTfulNodeOverrides_GetById1
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Node override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node override.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Properties / Overrides
summary: PutRESTfulNodeOverrides_Put
description: "This update method is triggered by sending PUT request directly to the resource's\r\n 'href' url. For data consistency verification 'href' (if presents) must be the same as the\r\n request url.\r\n'parent_node_type_property' cannot be changed.\r\nBy altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false).\r\n
\r\n
Use this node categories format for node override update:\r\n \r\n {\r\n \"parent_node_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi/v1/node_types/26000000000008/node_type_properties/28000000175500\"\r\n },\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"image\": \"5ybawbok.jpg\",\r\n \"instance_effect\": \"NoEffect\",\r\n \"parent_effect\": \"NoEffect\",\r\n \"upwards_propagation\": \"NoPropagations\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000008/node_type_properties/28000000175500/node_overrides/35\"\r\n }"
operationId: PutRESTfulNodeOverrides_Put
parameters:
- name: id
in: path
description: Node override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_property_id
in: path
description: Parent node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: x8a9vPwm7uOiUn2FKLiYF7mri2d1IRh4f4InV8uVWdYlU_sSowK6IFi1DtwYbTJ-kLN5V15mNP2AyRbtLxwJKWWsnmHDT50VBKN1j-pU_A5gGZCUMchGKgF9dyvpMKDzP-eTxUtBHhvroA9vWL4W_A2
requestBody:
description: Updated node override.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeOverride'
- description: Updated node override.
required: true
responses:
'200':
description: Node override update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node override cannot be found.
headers: {}
content: {}
'500':
description: Node override update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Properties / Overrides
summary: RESTfulNodeOverrides_Delete
description: Deletes a node override.
operationId: RESTfulNodeOverrides_Delete
parameters:
- name: id
in: path
description: Node override id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: node_type_property_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: EVlxE5j5tHR5skjavkjEkoDZ-CLjMvc6l8e58ee8eEGB9zebwv4VWwOspcOfp0e76V-glV0pKgcsTxlK62d9ubz8BmtJvO8Wy7RdmT8MHC5ku2lSvCjfqVaEFJUeXla9xxFz3EJY90icODQApQVU8w2
responses:
'200':
description: Node override deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Node override deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_property_values:
get:
tags:
- Nodes / Property Values
summary: RESTfulNodePropertyValues_Get
description: >-
This collection is useful when direct access to node property values is required.
For example, to search a property by its name and value when a parent node is unknown.
operationId: RESTfulNodePropertyValues_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes / Property Values
summary: RESTfulNodePropertyValues_Put
description: "'Type' property value cannot be updated.\r\nNode property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a node in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010516/node_property_values/7334\"\r\n }\r\n \r\n Use the following format if you know the node property value's name:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"name\": \"Status\",\r\n \"parent_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010516\"\r\n }\r\n }\r\n \r\n Use the following format if you know the node property value's parent property:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"node_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123/node_type_properties/28000000000456\"\r\n },\r\n \"parent_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010516\"\r\n }\r\n }\r\n \r\n For multiple property values update (batch update) use an array of properties,\r\n each property may use any available format (the response will contain an array of errors\r\n for unsuccessfully updated property values from the array):\r\n \r\n [{\r\n \"node_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123/node_type_properties/28000000000456\"\r\n },\r\n \"parent_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000002692\"\r\n },\r\n \"value\": \"Cisco WS-C2960-24-S\"\r\n },\r\n {\r\n \"name\": \"Status\",\r\n \"parent_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000002692\"\r\n },\r\n \"value\": \"Online\",\r\n }]"
operationId: RESTfulNodePropertyValues_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: xT7JyUHPHvNwfGIi_tIz7_je2CfakyAvDUV0ENiogD7f8Q1y0x78oTrCUUqHhgYqyTD0LRrmORwNYmx9Aig3bODBZTVy31XaavJGh5MJkHIzmL-Z4VtoaN5X9hxSBdNjWjJb9m7o182iOIMgKitUsg2
requestBody:
description: Updated node property value. Or values array.
content:
application/json:
schema:
type: object
description: Updated node property value. Or values array.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_property_values/{id}:
get:
tags:
- Nodes / Property Values
summary: RESTfulNodePropertyValues_GetById
description: 'Node id example: 24000000000123, Node property value id example: 123.'
operationId: RESTfulNodePropertyValues_GetById
parameters:
- name: id
in: path
description: Node property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/node_property_values:
get:
tags:
- Nodes / Property Values
summary: GetRESTfulNodePropertyValues_Get
description: Gets the node property values collection.
operationId: GetRESTfulNodePropertyValues_Get
parameters:
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes / Property Values
summary: PutRESTfulNodePropertyValues_Put
description: "'Type' property value cannot be updated.\r\nNode property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a node in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010516/node_property_values/7334\"\r\n }\r\n \r\n Use the following format if you know the node property value's name:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"name\": \"Status\"\r\n }\r\n \r\n Use the following format if you know the node property value's parent property:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"node_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123/node_type_properties/28000000000456\"\r\n }\r\n }"
operationId: PutRESTfulNodePropertyValues_Put
parameters:
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: z9-KOIZRlIt-BlqPFNEwl8ZTo0QmUpZgXQgaLom-nSjRRfVol1GG2ZmRYu1jNAvgY6bTDAEhgwICSHWMO5phSrt4rJD1ZBXH-qnXZUMXh1YqXLhHLfduGHlaIYxnYQ_KB0eRAS7BHYudhow9gpWvyw2
requestBody:
description: Updated node property value id.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
- description: Updated node property value id.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/node_property_values/{id}:
get:
tags:
- Nodes / Property Values
summary: GetRESTfulNodePropertyValues_GetById
description: 'Node id example: 24000000000123, Node property value id example: 123.'
operationId: GetRESTfulNodePropertyValues_GetById
parameters:
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Node property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Property Values
summary: PutRESTfulNodePropertyValues_Put1
description: "'Type' property value cannot be updated.\r\nNode property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n
During creation of a node in the property has a default value.\r\n
With the special \"POST .../init_absent_values\" method.\r\n
With this PUT method. See the examples.\r\n
Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\"\r\n }"
operationId: PutRESTfulNodePropertyValues_Put1
parameters:
- name: id
in: path
description: Node property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: h8nAdKu6RMVn5cZFMTBaEjaDj2pvdsxFgZrOj-JXrrwTCT6KlYTxXjmaJknrtKkQXrEF_v6KwDBl1fZ9qbty46UgwxH5iA6k8UP4kRzoQLZ9J2Dpy55nv65qs_fZ_XjIjU1U5aTByP_cCplknly5Hw2
requestBody:
description: Updated node property value id.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodePropertyValue'
- description: Updated node property value id.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/node_property_values/init_absent_values:
post:
tags:
- Nodes / Property Values
summary: RESTfulNodePropertyValues_InitAbsentValues
description: >-
All created node property values will be empty and 'Type' property value will
contain a node type name.
operationId: RESTfulNodePropertyValues_InitAbsentValues
parameters:
- name: node_id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: QBybC2nnxVVPB5ipurKM1MhaIF-medaL_8QfxZSh5HaMuql0XY6xPCpJOXl6cswGJKK5XOcdao1R0qYCLnHc1vYwhRgu2_wK4tnRHFA1mA7baT0zXVFNsT6JdBVipCpCkGqGeG2p0iG2HpVjuu5qZw2
responses:
'200':
description: All node property values has already been created before.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'201':
description: Node property values were successfully created.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'404':
description: The node does not exist.
headers: {}
content: {}
'500':
description: Node property values creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_type_properties:
get:
tags:
- Node Types / Properties
summary: RESTfulNodeTypeProperties_Get
description: Gets the node type properties collection with no relation to a specific node type.
operationId: RESTfulNodeTypeProperties_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Properties
summary: RESTfulNodeTypeProperties_Put
description: "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this node type properties format for node override update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"is_type_field\": false,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"system_object_id\": \"1.3.6.1.2.1.4.21.1.1\",\r\n \"is_not_editable\": false,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002667/node_type_properties/28000000003733\"\r\n }\r\n \r\n For multiple properties update (batch update) use an array of properties,\r\n the response will contain an array of errors for unsuccessfully updated properties\r\n from the array:\r\n \r\n [{\r\n \"default_value\": \"20\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002667/node_type_properties/28000000003733\"\r\n },\r\n {\r\n \"default_value\": \"0\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002667/node_type_properties/28000000003734\"\r\n }]"
operationId: RESTfulNodeTypeProperties_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: WfLu1H7eNY7qKMSXzCXejlCkVbZI_fqHkj8zPVPfcLiXWzWmse-j2eNxaDuyareMe0nhmOaat4k8KAsGlcrJ7mey1ecYmAqgYxkxlpvD-QPXuC6RBQ_DKXWlOCmRvrgcemsrF0kwQnb4IowsetBlew2
requestBody:
description: Updated node type property. Or properties array.
content:
application/json:
schema:
type: object
description: Updated node type property. Or properties array.
required: true
responses:
'200':
description: Node type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node type property cannot be found.
headers: {}
content: {}
'500':
description: Node type property update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Properties
summary: RESTfulNodeTypeProperties_Post
description: "
Use this node type property format for node type property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"is_type_field\": false,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"parent_node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002667\"\r\n },\r\n \"system_object_id\": \"\",\r\n \"is_not_editable\": false\r\n }"
operationId: RESTfulNodeTypeProperties_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: oyDo3fdMeekd6tbpDR4eNh9oOh3Zc9N0jEA7dQHUYsjWFWonJTDXBPu9vb84YZFPtAjRSKXYBb30qxwdbZ8mA_njCmcHydl1auakIktp8atIr8ctq61MEkrAmvpvoKPVEFZILpHiGiKS6cJLEqUwxg2
requestBody:
description: New node type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
- description: New node type property.
required: true
responses:
'201':
description: Node type property creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node type property should not contain 'href'.
headers: {}
content: {}
'500':
description: Node type property creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_type_properties/{id}:
get:
tags:
- Node Types / Properties
summary: RESTfulNodeTypeProperties_GetById
description: 'Node type property id example: 28000000000076'
operationId: RESTfulNodeTypeProperties_GetById
parameters:
- name: id
in: path
description: Node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node type property.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types/{node_type_id}/node_type_properties:
get:
tags:
- Node Types / Properties
summary: GetRESTfulNodeTypeProperties_Get
description: Gets the node type properties collection.
operationId: GetRESTfulNodeTypeProperties_Get
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Properties
summary: PutRESTfulNodeTypeProperties_Put
description: "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this node type properties format for node override update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"is_type_field\": false,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"system_object_id\": \"1.3.6.1.2.1.4.21.1.1\",\r\n \"is_not_editable\": false,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002667/node_type_properties/28000000003733\"\r\n }"
operationId: PutRESTfulNodeTypeProperties_Put
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: sa7BpGPU_l5Q0jdeGSM0-cNuOA-HsT7MxJTujLIgrU0cefVVWbJ3J3BBN15uHvhhOZzH6lI73k7ZSlpPsgbe-VWP0KWsJWgsKitmZca9pCKxX1aNJTSSwD0l78Eaqran3idu6Rr9nfwm4ls_Cu8tHQ2
requestBody:
description: Updated node type property.
content:
application/json:
schema:
type: object
description: Updated node type property.
required: true
responses:
'200':
description: Node type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node type property cannot be found.
headers: {}
content: {}
'500':
description: Node type property update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Properties
summary: PostRESTfulNodeTypeProperties_Post
description: "
Use this node type property format for node type property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"is_type_field\": false,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"system_object_id\": \"\",\r\n \"is_not_editable\": false\r\n }"
operationId: PostRESTfulNodeTypeProperties_Post
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: JT8zU0zuzAHRQCdT_1LLLlZ9cqiJiGt6kVEpU3bpRPXcQxKCsjx-wreEum8L-HeXzV_UMUdgEgljFdP_ew9DOjmnTskqWCeeAtjd3eOa4tWj85oHIQe4tancmvijuZn9NG270OpbYfwqU-jQH6XiNg2
requestBody:
description: New node type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
- description: New node type property.
required: true
responses:
'201':
description: Node type property creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node type property should not contain 'href'.
headers: {}
content: {}
'500':
description: Node type property creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types/{node_type_id}/node_type_properties/{id}:
get:
tags:
- Node Types / Properties
summary: GetRESTfulNodeTypeProperties_GetById
description: 'Node type property id example: 28000000000076'
operationId: GetRESTfulNodeTypeProperties_GetById
parameters:
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node type property.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Properties
summary: PutRESTfulNodeTypeProperties_Put1
description: "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed.\r\nSystem status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position.\r\nThe typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n uniqueforthistype, uniqueforalltypes.\r\nThe locklist parameter cannot be set to 'true' if a property does not have any\r\n list values.\r\nThe system_object_id can only be set for the properies of the Device\r\n type group.\r\n
\r\n
Use this node type properties format for node override update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n \"fill_color\": \"\",\r\n \"offset_x\": 0,\r\n \"offset_y\": -15,\r\n \"angle\": 0,\r\n \"is_bold\": false,\r\n \"is_italic\": false,\r\n \"is_underlined\": false,\r\n \"is_lock_list\": false,\r\n \"is_type_field\": false,\r\n \"is_unique_for_this_type\": false,\r\n \"is_unique_for_all_types\": false,\r\n \"system_object_id\": \"1.3.6.1.2.1.4.21.1.1\",\r\n \"is_not_editable\": false,\r\n }"
operationId: PutRESTfulNodeTypeProperties_Put1
parameters:
- name: id
in: path
description: Node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_id
in: path
description: Parent node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: OtMr7mt4zf2CHMYrgdTT8vR9c88tQVkCk-SZNa_DE0PrkZYlP_XscBAZ--AJdroKc5ulu9gJrrXEHDQkndu_t7OYBDeF6crimpHgttq_5uzbUs2MxUcDEbDj6TnUrNCJ4DLj9maV334sizbu2ojcAw2
requestBody:
description: Updated node type property.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeTypeProperty'
- description: Updated node type property.
required: true
responses:
'200':
description: Node type property update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node type property cannot be found.
headers: {}
content: {}
'500':
description: Node type property update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Properties
summary: RESTfulNodeTypeProperties_Delete
description: Only non-system node type properties can be deleted.
operationId: RESTfulNodeTypeProperties_Delete
parameters:
- name: id
in: path
description: Node type property id.
required: true
style: simple
schema:
type: integer
format: int64
- name: node_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: FP_7hMbmjin_sGp_Afzz8yne2Vv1GfUzVFb4Cfh27K6LsqI3MMNQtHSnAVuboMfgM6YrAMrcf5MyXysX4gKl8FAH73GtOJmUTiYoyofW4QUqVjcJXc6pShGa3XK88P5vIeOghRPfJG0LqA0zwQTfrw2
responses:
'200':
description: Node type property deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Node type property deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types:
get:
tags:
- Node Types
summary: RESTfulNodeTypes_Get
description: Gets the node types collection.
operationId: RESTfulNodeTypes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types
summary: RESTfulNodeTypes_Put
description: "System node types cannot be updated. The system parameter cannot be altered\r\n either.\r\nThe type group of the node type cannot be changed.\r\nWhen altering the name parameter (renaming the node type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite node type or a node type with existing node instances cannot be\r\n disabled.\r\nThe background, vendor, width and height parameters\r\n can only be set for node types that were modelled as Racks, Devices and\r\n Cards.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current node type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the same type group.\r\n \r\nThe displayracklines can only be set to true for the Rack type\r\n group.\r\n \r\n
\r\n
Use this node type format for node override update:\r\n \r\n {\r\n \"name\": \"Region\",\r\n \"image\": \"Region.png\",\r\n \"background\": \"\",\r\n \"default_height\": 50,\r\n \"default_width\": 50,\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"description\": \"\",\r\n \"is_keep_aspect_ratio\": false,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_type_properties/28000000027700\"\r\n },\r\n \"node_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000006\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002658\"\r\n }"
operationId: RESTfulNodeTypes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: z1bu6OwTNlSEQcIY1wK2LSh5WFpSn0cO6OZmnve2P4zyQQ98hx2Xei6BIcUl8Pc1ZWFbbAu4XVaCzPmGFhOxo_RhVySHfaPz_pkNVbumlXejyebA0hMDBHuneVqktI2m7uv-LfbWTDDJiMkfRJiwsA2
requestBody:
description: Updated node type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeType'
- description: Updated node type.
required: true
responses:
'200':
description: Node type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node type cannot be found.
headers: {}
content: {}
'500':
description: Node type update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types
summary: RESTfulNodeTypes_Post
description: "It is only possible to add node types of following type groups:\r\n Node, Device, Rack, Card.\r\n \r\n
Use this node types format for node type create:\r\n \r\n {\r\n \"name\": \"Region\",\r\n \"image\": \"Region.png\",\r\n \"background\": \"\",\r\n \"default_height\": 50,\r\n \"default_width\": 50,\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"description\": \"\",\r\n \"is_keep_aspect_ratio\": false,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_type_properties/28000000027700\"\r\n },\r\n \"node_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000006\"\r\n }\r\n }"
operationId: RESTfulNodeTypes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Wu0-8KTwiDIkY6RlPkPRe19vanQ9YhsciRY3noyiWYGmtWvD0REG54WRwkro4v19b5aQP6ewE-RjayeaR4UexyjD6jIxjIPsTgr0onMDKLSCx6hPhCe9t2WlRQcn5EEtVuGfF2a-V8cYic5SuFlvzQ2
requestBody:
description: New node type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeType'
- description: New node type.
required: true
responses:
'201':
description: Node type creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node type should not contain 'href'.
headers: {}
content: {}
'500':
description: Node type creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/node_types/{id}:
get:
tags:
- Node Types
summary: RESTfulNodeTypes_GetById
description: 'Node type id example: 26000000000123'
operationId: RESTfulNodeTypes_GetById
parameters:
- name: id
in: path
description: Node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeType'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeType'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types
summary: PutRESTfulNodeTypes_Put
description: "System node types cannot be updated. The system parameter cannot be altered\r\n either.\r\nThe type group of the node type cannot be changed.\r\nWhen altering the name parameter (renaming the node type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite node type or a node type with existing node instances cannot be\r\n disabled.\r\nThe background, vendor, width and height parameters\r\n can only be set for node types that were modelled as Racks, Devices and\r\n Cards.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current node type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the same type group.\r\n \r\nThe displayracklines can only be set to true for the Rack type\r\n group.\r\n \r\n
\r\n
Use this node type format for node override update:\r\n \r\n {\r\n \"name\": \"Region\",\r\n \"image\": \"Region.png\",\r\n \"background\": \"\",\r\n \"default_height\": 50,\r\n \"default_width\": 50,\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"description\": \"\",\r\n \"is_keep_aspect_ratio\": false,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_type_properties/28000000027700\"\r\n },\r\n \"node_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000006\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000002658\"\r\n }"
operationId: PutRESTfulNodeTypes_Put
parameters:
- name: id
in: path
description: Node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 4_Ym6H2fzVQDxuNYURT53aqHYc_TcDtiuKzUlSRHmuhcS6js3gHDQ7ckXj29rvpaa0QRTrthuL0hkDfv6xq-ZorxsCtveyK0Gp7vGuoBdZiVrSkEMCy_hOH-vlGJ0ierY5Nl6z8w6xZZ_Hh_nz50Hw2
requestBody:
description: Updated node type.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeType'
- description: Updated node type.
required: true
responses:
'200':
description: Node type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node type cannot be found.
headers: {}
content: {}
'500':
description: Node type update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types
summary: RESTfulNodeTypes_Delete
description: Only non-system node types without associated nodes can be deleted.
operationId: RESTfulNodeTypes_Delete
parameters:
- name: id
in: path
description: Node type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: SteWula_SGjSe8e1bCYeDOr1QW79f4OotYgJI2PC4MS5ruVpx6t0-GCkPL2s-A8vnlqLEl0CErNa0pWWGT5ZtRN0L5m5Q7fi0A7SfRoyhpTX9sMKB6D8lQjDGCp1ocwvwvjVBOQyxmZz5WOCHa-F8A2
responses:
'200':
description: Node type deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Node type deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes:
get:
tags:
- Nodes
summary: RESTfulNodes_Get
description: Gets the nodes collection.
operationId: RESTfulNodes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes
summary: RESTfulNodes_Put
description: "
Use this node format:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }"
operationId: RESTfulNodes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 9No9NDf33CnL5P5HlwBsEYYPOJlJl2yBi_VGjyTzxw_OXye5W6g9WXMSx0rAQ9HYz_9OEC2SQpkHBKMJ47Zz8zLNSfYRJUWf30gMrvIuoUu_vX8P6ucKaItXoote-Ds1Ky8HeF4kTytmYC_ECD8CMg2
requestBody:
description: Updated node.
content:
application/json:
schema:
type: object
description: Updated node.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Nodes
summary: RESTfulNodes_Post
description: "
Use this node format for new node creation:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n }\r\n }"
operationId: RESTfulNodes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: D_GlVMW16B2DnWsZku4pOGSzYcyJ06hIvByNvvql_XMBiuLAf0njZnqzNXjjYl3VQUxMYy7rzv6MtG0M3TEVQIBJGhT7PZ928_qe4y_kPWQ-uk3eQGwhHzFCZrwKB9tcl5l5WV1KWbqf7KlXzc_RPw2
requestBody:
description: New node.
content:
application/json:
schema:
type: object
description: New node.
required: true
responses:
'201':
description: Node creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node should not contain 'href'.
headers: {}
content: {}
'500':
description: Node creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{id}:
get:
tags:
- Nodes
summary: RESTfulNodes_GetById
description: 'Node id example: 24000000000123'
operationId: RESTfulNodes_GetById
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Node'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Node'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes
summary: PutRESTfulNodes_Put
description: "
Use this node format:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }"
operationId: PutRESTfulNodes_Put
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: o-4KiX0CV94SIofSHV4ROyiefTAUYjaAfzI_hWdwSPs6Q8Vl9DcT3OMbefsQDm9o1LTbi3X31S8CtnL6RMAz16zSejPwGTLtGLQilDIcYMf47z5yscrceBGLUD5kJi-jNEJGL_JyT02Ufe21u5AH7A2
requestBody:
description: Updated node.
content:
application/json:
schema:
type: object
description: Updated node.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Nodes
summary: RESTfulNodes_Delete
description: Deletes a node.
operationId: RESTfulNodes_Delete
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: PrCdwcuI6we8dJG_C1wn6jj36z2nX6zzOOikjUr0hjsK7vZpmVt0nIZn2zTmQr6xmY4snLRR3-xH1LkdXbU_b03TGEwqC5ikq9pptoVDkLVj3IN6R0cdhvUbby3RE-eCz9PK56JEbN36wS4KXn7oWw2
responses:
'200':
description: Node deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Node deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{master_node_id}/aliases:
get:
tags:
- Nodes
summary: RESTfulNodes_GetAliases
description: Gets the collection of node aliases.
operationId: RESTfulNodes_GetAliases
parameters:
- name: master_node_id
in: path
description: Id of a node to get aliases for.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Nodes
summary: RESTfulNodes_PostAlias
description: "
Use this node format for new node creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }\r\n }"
operationId: RESTfulNodes_PostAlias
parameters:
- name: master_node_id
in: path
description: Master node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ILE38gRiGvDs4hGSl_jForrT7KXfIu4hwva-_sFw0AzX2Ic5vigMGZrLWVKs7rTDhOLv3cZ9Ajywd7EJkeRPReVEOjLvxG7Nya4LOwhkCRyS-hiFExPbkwPDZyUEBuCyAfN5DukjQt98g2dTHLHPrg2
requestBody:
description: New node alias.
content:
application/json:
schema:
type: object
description: New node alias.
required: true
responses:
'201':
description: Node creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new node should not contain 'href'.
headers: {}
content: {}
'500':
description: Node creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/separate_links:
put:
tags:
- Nodes
summary: PutRESTfulNodes_Put1
description: "
Use this format for links separation:\r\n \r\n {\r\n \"node_1\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028506\"\r\n },\r\n \"node_2\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028507\"\r\n },\r\n \"distance\": 50,\r\n \"bend_points_number\": 4,\r\n \"is_curved\": true\r\n }"
operationId: PutRESTfulNodes_Put1
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 2YHHfy6Rh32o59o1Rtw4VGZar8XRWE_diNFNHX24ypnPVKO01mnU2UsdcPX65UA6nDMnDsIpO6e2u1qEJvoQ82xuslNzfQzRu_qi8CFESBwFLbwXYdFIseL_wsx2CTvUtYzGoijCVTKNAMLQHpH3rQ2
requestBody:
description: Separation parameters.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisLinksSeparationData'
- description: Separation parameters.
required: true
responses:
'200':
description: Vis links update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: Some object cannot be found.
headers: {}
content: {}
'500':
description: Links separation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{id}/diagram_settings:
get:
tags:
- Nodes / Diagram settings
summary: RESTfulDiagramSettings_GetDiagramSettings
description: 'Node id example: 24000000000123'
operationId: RESTfulDiagramSettings_GetDiagramSettings
parameters:
- name: id
in: path
description: Node (diagram) id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns diagram settings of the existing node.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.DiagramSettings'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.DiagramSettings'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Diagram settings
summary: RESTfulDiagramSettings_Put
description: "
Use this format for diagram settings update:\r\n \r\n {\r\n \"page_color\": \"#ffffff\",\r\n \"diagram_width\": 1100,\r\n \"diagram_height\": 850,\r\n \"diagram_margin_size\": 50,\r\n \"is_blocked\": false,\r\n \"is_hidden\": \"\",\r\n \"auto_layout_state\": 0,\r\n \"map_coord_left\": 0,\r\n \"map_coord_top\": 0,\r\n \"map_coord_right\": 0,\r\n \"map_coord_bottom\": 0,\r\n \"map_units_type\": 0,\r\n \"map_source\": 0,\r\n \"is_display_grid\": false,\r\n \"is_snap_to_grid\": false,\r\n \"grid_spacing_x\": 50,\r\n \"grid_spacing_y\": 50,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000001/diagram_settings\"\r\n }"
operationId: RESTfulDiagramSettings_Put
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: vr5Pmzqg8meSvtRiydMuwb2RMN7YpB2B-fjpmGAI9tJHwoAXzxCnR8ykuSW65lXWe8WerJjL9GdGb1BA9_GvnpLE4uZNg-bvSkUU3c_0rt4x_A5YBCUrcKYeojW1bGcX5VfR4B12C4m_b0ea8gvxsQ2
requestBody:
description: Updated node's diagram settings.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.DiagramSettings'
- description: Updated node's diagram settings.
required: true
responses:
'200':
description: Diagram settings update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node cannot be found.
headers: {}
content: {}
'500':
description: Diagram settings update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{id}/map_coordinates:
get:
tags:
- Nodes / Map coordinates
summary: RESTfulNodeMapCoordinates_GetMapCoordinates
description: A node has map coordinates only when placed on a map diagram.
operationId: RESTfulNodeMapCoordinates_GetMapCoordinates
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns map coordinates of the existing node.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.MapCoordinates'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.MapCoordinates'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Map coordinates
summary: RESTfulNodeMapCoordinates_Put
description: "\r\n
Use this format for map coordinates update:\r\n \r\n {\r\n \"x\": 12.02441354,\r\n \"y\": -34.56026252\r\n \"units\": \"DynamicLatLon\"\r\n }\r\nCoordinates should be set in degrees."
operationId: RESTfulNodeMapCoordinates_Put
parameters:
- name: id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: nBP4piaV2j4-ksi1NFPImiSWV1Vy07bwXeIl4FeBjOgzhGGMObp0wjRlRlFvJaodah9GLC5KsH1yt6LBmmVfQRmFNUDxkuNNCjwj-LbKt1U0YQI22n_6HW8jAvrDW1cmOU9BL9KqVuR54L88QGzAyg2
requestBody:
description: Updated node's map coordinates.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.MapCoordinates'
- description: Updated node's map coordinates.
required: true
responses:
'200':
description: Map coordinates update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The node cannot be found.
headers: {}
content: {}
'500':
description: Map coordinates update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/vis_nodes:
get:
tags:
- Nodes / Vis Nodes
summary: RESTfulVisNodes_Get
description: Gets the vis nodes collection.
operationId: RESTfulVisNodes_Get
parameters:
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes / Vis Nodes
summary: RESTfulVisNodes_Put
description: "
Use this format for vis node update:\r\n \r\n {\r\n \"x\": 198,\r\n \"y\": 240,\r\n \"width\": 50,\r\n \"height\": 50,\r\n \"is_keep_aspect_ratio\": false,\r\n \"can_move\": true,\r\n \"can_resize\": true,\r\n \"can_rotate\": true,\r\n \"can_delete\": true,\r\n \"is_hidden\": false,\r\n \"z_order\": 0,\r\n \"angle\": 0,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010518/vis_nodes/2738\"\r\n }"
operationId: RESTfulVisNodes_Put
parameters:
- name: node_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: I0rrmletprxefNnAI3MeyyCJ6YYpCyof6GolpAz73R1Fat8IPXb36GZpjKhbB-NnlEXsoorjNutVvPkbmzXYccJT9OPY6PnxVSO5p0QPnipsNPXv5e_41nWFVostX-9ls-h6Z3aPeSBos9rEBpoFVA2
requestBody:
description: Updated vis node.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisNode'
- description: Updated vis node.
required: true
responses:
'200':
description: Vis node update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The vis node cannot be found.
headers: {}
content: {}
'500':
description: Vis node update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/vis_nodes/{id}:
get:
tags:
- Nodes / Vis Nodes
summary: RESTfulVisNodes_GetById
description: 'Node id example: 24000000000123, Vis Node id example: 123'
operationId: RESTfulVisNodes_GetById
parameters:
- name: node_id
in: path
description: Parent node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Vis Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing vis node.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisNode'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisNode'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/vis_nodes/original:
get:
tags:
- Nodes / Vis Nodes
summary: RESTfulVisNodes_GetOriginal
description: 'Node id example: 24000000000123'
operationId: RESTfulVisNodes_GetOriginal
parameters:
- name: node_id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing vis node.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisNode'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.VisNode'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/nodes/{node_id}/vis_nodes/references:
get:
tags:
- Nodes / Vis Nodes
summary: RESTfulVisNodes_GetReferences
description: Gets the collection of reference vis nodes of the specified node.
operationId: RESTfulVisNodes_GetReferences
parameters:
- name: node_id
in: path
description: Node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/rack_container_designs:
get:
tags:
- Node Types / Racks Types / Container Designs
summary: RESTfulRackContainerDesigns_Get
description: >-
This collection is useful when direct access to rack type container designs is
needed. For example, to find containers of certain capacity.
operationId: RESTfulRackContainerDesigns_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Racks Types / Container Designs
summary: RESTfulRackContainerDesigns_Put
description: "
Use this container design format for container design update:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3987,\r\n \"width\": 172.459,\r\n \"height\": 699.639\r\n \"href\": \"http://localhost/NetTerrain/wapi/v1/rack_types/26000000002663/rack_container_designs/29\"\r\n }"
operationId: RESTfulRackContainerDesigns_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Svw4xqowJetcVoH6gcwMKjg6WGWs-EcLhxQBBp-EYVV801odqtehJ_EafCGarVqEAUOcMUiX4zKCNwgeY-EP8OM0xaPr83JGkE2sf70sTsZoUAT314bIYnD2D6BdxcqsBQZ4FFmpZ0mPkgAwB8H6JA2
requestBody:
description: Rack type's container design body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
- description: Rack type's container design body with updated data.
required: true
responses:
'200':
description: Rack type's container design update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The rack type's container design cannot be found.
headers: {}
content: {}
'500':
description: Rack type's container design update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Racks Types / Container Designs
summary: RESTfulRackContainerDesigns_Post
description: "
Use this rack type's container design format for rack type's container design creation:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3987,\r\n \"width\": 172.459,\r\n \"height\": 699.639\r\n }"
operationId: RESTfulRackContainerDesigns_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: ibGcLQRjISZOibeuQDgZLKr9LT7DwB8dc5WeK_DXWbhqQSF2d231bHZrNlynpYdfJ61r9UQj__ACune99vJqZ7NdIWqhwmakhjBnQAHEoU6aLId3Bu1UIrsip8ZfAI5KHGZpNjBZzevGLYt11rJG-w2
requestBody:
description: New rack type's container design body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
- description: New rack type's container design body.
required: true
responses:
'201':
description: Rack type's container design creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new rack type's container design should not contain
'href'.
headers: {}
content: {}
'500':
description: Rack type's container design creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/rack_container_designs/{id}:
get:
tags:
- Node Types / Racks Types / Container Designs
summary: RESTfulRackContainerDesigns_GetById
description: 'Rack type id example: 26000000014512'
operationId: RESTfulRackContainerDesigns_GetById
parameters:
- name: id
in: path
description: Container design id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the container design of the existing rack type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/rack_types/{rack_type_id}/rack_container_designs:
get:
tags:
- Node Types / Racks Types / Container Designs
summary: GetRESTfulRackContainerDesigns_Get
description: Gets the container designs collection for a rack type.
operationId: GetRESTfulRackContainerDesigns_Get
parameters:
- name: rack_type_id
in: path
description: Host rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Node Types / Racks Types / Container Designs
summary: PostRESTfulRackContainerDesigns_Post
description: "
Use this rack type's container design format for rack type's container design creation:\r\n \r\n {\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3987,\r\n \"width\": 172.459,\r\n \"height\": 699.639\r\n }"
operationId: PostRESTfulRackContainerDesigns_Post
parameters:
- name: rack_type_id
in: path
description: Parent rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: nKNw-Ma-JVBZSNhWQDDMxAm2mIKxd78r8CtwdYUKV3xFdUt7aqyMV8HoTGbmeGMpFZH69HMv9mDtE4vgBHHxJYhVOtELtRIY5EZ1Pv1S9C_5EdbqF8m5Rr5PPe1Nua2tatQ4dGonF9yF3JWT4057jg2
requestBody:
description: New rack type's container design body.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
- description: New rack type's container design body.
required: true
responses:
'201':
description: Rack type's container design creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: >-
Conflict - a new rack type's container design should not contain
'href'.
headers: {}
content: {}
'500':
description: Rack type's container design creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/rack_types/{rack_type_id}/rack_container_designs/{id}:
get:
tags:
- Node Types / Racks Types / Container Designs
summary: GetRESTfulRackContainerDesigns_GetById
description: 'Rack type id example: 26000000014512'
operationId: GetRESTfulRackContainerDesigns_GetById
parameters:
- name: rack_type_id
in: path
description: Host rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Container design id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the container design of the existing rack type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Racks Types / Container Designs
summary: PutRESTfulRackContainerDesigns_Put
description: "
Use this container design format for container design update:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3987,\r\n \"width\": 172.459,\r\n \"height\": 699.639\r\n \"href\": \"http://localhost/NetTerrain/wapi/v1/rack_types/26000000002663/rack_container_designs/29\"\r\n }"
operationId: PutRESTfulRackContainerDesigns_Put
parameters:
- name: id
in: path
description: Container design id.
required: true
style: simple
schema:
type: integer
format: int64
- name: rack_type_id
in: path
description: Parent rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 7NXmIWE08fQtg_6gVVX9pgS1uLrHEMkoQJfw_MJXswpgoJD3P2Q9ZU8h84GB1eH_zHQ4SnSE_G9R1wMotS14khhyKAtSLJYVQIDjX7-bcPYthS0SU1AL6g-mSBU4ja8hCkRn0jQBzC7H2V6FQ-ny9w2
requestBody:
description: Rack type's container design body with updated data.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainerDesign'
- description: Rack type's container design body with updated data.
required: true
responses:
'200':
description: Rack type's container design update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The rack type's container design cannot be found.
headers: {}
content: {}
'500':
description: Rack type's container design update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Racks Types / Container Designs
summary: RESTfulRackContainerDesigns_Delete
description: Deletes the rack type's container design.
operationId: RESTfulRackContainerDesigns_Delete
parameters:
- name: id
in: path
description: Container design id.
required: true
style: simple
schema:
type: integer
format: int64
- name: rack_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: AxvETs7nQvoeMOBclv6W0WB_JmjfEy1yB2_uy6POvzI6LkzZwd1WsQUtvuMsULqm4SakaqIYobrla0o5_PM5uvs0bf-RdXFRr1ywbbz3-WQV--Lsgwkm54xw_AraH3ig0eWAxflhbNsVPUXqsNiO_Q2
responses:
'200':
description: Container design deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Container design deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/rack_types:
get:
tags:
- Node Types / Rack Types
summary: RESTfulRackTypes_Get
description: Gets the rack types collection.
operationId: RESTfulRackTypes_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Node Types / Rack Types
summary: RESTfulRackTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the rack type cannot be changed.\r\nWhen altering the name parameter (renaming the rack type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite rack type or a rack type with existing rack instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current rack type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Rack' type group.\r\n \r\n
Use this rack type format for rack override update:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"name\": \"My Rack\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My rack description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"rack_units_capacity\": 24,\r\n \"power\": 800.0,\r\n \"max_weight\": 63.0,\r\n \"is_display_rack_lines\": false,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000010042\"\r\n }"
operationId: RESTfulRackTypes_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: V4ML1A7D7x26EjhwZFgtCKqcBFLG5HO1IAr-uD568E7xHvmUa81zLLcI8qUUi_na7ILs3yl003jxiaiFmdjxJwmc0oArJPzNdciqNEqL4mXIOFw55WbV2JIJK6Mt_qBbIEG9dtJQ0toSQmSPJAdjag2
requestBody:
description: Updated rack type.
content:
application/json:
schema:
type: object
description: Updated rack type.
required: true
responses:
'200':
description: Rack type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The rack type cannot be found.
headers: {}
content: {}
'500':
description: Rack type update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Node Types / Rack Types
summary: RESTfulRackTypes_Post
description: "
Use this rack types format for rack type create:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"image\": \"MyRack.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My Rack\",\r\n \"background\": null,\r\n \"power\": 1200.0,\r\n \"max_weight\": 100.0,\r\n \"is_display_rack_lines\": true,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: RESTfulRackTypes_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: mBDhLDgjiChXOjaUYf6w6sYDTIjXhG0TOtAVWQAX7VufHYx58wF3ebFJZugJKLOGPi7p1TbWcRcA3THr2LxVBmIjsxn58TiUiu8SOvtG5GbkIMHsTHAfUNfxCT2aGGC6ULGi1U04b_HpjYapBTRJag2
requestBody:
description: New rack type.
content:
application/json:
schema:
type: object
description: New rack type.
required: true
responses:
'201':
description: Rack type creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new rack type should not contain 'href'.
headers: {}
content: {}
'500':
description: Rack type creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/rack_types/{id}:
get:
tags:
- Node Types / Rack Types
summary: RESTfulRackTypes_GetById
description: 'Rack type id example: 26000000000123'
operationId: RESTfulRackTypes_GetById
parameters:
- name: id
in: path
description: Rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing rack type.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackType'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackType'
'400':
description: Node type of a different type group.
headers: {}
content: {}
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Node Types / Rack Types
summary: PutRESTfulRackTypes_Put
description: "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\nThe type group of the rack type cannot be changed.\r\nWhen altering the name parameter (renaming the rack type) the new name must be\r\n unique.\r\nWhen changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r\nA favorite rack type or a rack type with existing rack instances cannot be\r\n disabled.\r\nThe hierarchybrowserlabel (Hierarchy browser label) only accepts the property\r\n Id of properties belonging to the current rack type.\r\nThe new template should correspond to a template node.\r\nThe category should correspond to a node category of the 'Rack' type group.\r\n \r\n
Use this rack type format for rack override update:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"name\": \"My Rack\",\r\n \"default_height\": 50.0,\r\n \"default_width\": 50.0,\r\n \"is_favorite\": true,\r\n \"is_enabled\": true,\r\n \"description\": \"My rack description\",\r\n \"is_keep_aspect_ratio\": true,\r\n \"double_click_behavior\": \"DrillDown\",\r\n \"double_click_behavior_attribute\": \"\",\r\n \"template\": null,\r\n \"hierarchy_browser_label\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042/node_type_properties/28000000109876\"\r\n },\r\n \"node_category\": null,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000010042\"\r\n },\r\n \"name\": \"DDB Unlimited SOD-372420\",\r\n \"background\": null,\r\n \"rack_units_capacity\": 24,\r\n \"power\": 800.0,\r\n \"max_weight\": 63.0,\r\n \"is_display_rack_lines\": false,\r\n \"in_stock\": 20,\r\n \"vendor\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/752\"\r\n }\r\n }"
operationId: PutRESTfulRackTypes_Put
parameters:
- name: id
in: path
description: Rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 616A7STqvPaOccT273Nl97lAvHxhhwZQghOqROUdoLeLPB9Dat5mQvdx7qUzHrS7qtZG53rzK4JRk2l-TeEOoeTrc_-o3mXbQqcTrZQRDb6jvKS1ge_I5D9o6GyE9lu5aLTfspnRrs6aOl3RU-COJw2
requestBody:
description: Updated rack type.
content:
application/json:
schema:
type: object
description: Updated rack type.
required: true
responses:
'200':
description: Rack type update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The rack type cannot be found.
headers: {}
content: {}
'500':
description: Rack type update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Node Types / Rack Types
summary: RESTfulRackTypes_Delete
description: Only types without associated racks can be deleted.
operationId: RESTfulRackTypes_Delete
parameters:
- name: id
in: path
description: Rack type id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: NjbgAChsL6wRc7hXD4CH1TA1ioYnl_m2LJX6XS84YUMIgDDAYkl9ApvUyomQhYunD22MWTaBAXweijP-_SoPSyjlIYoBWC8DwuE_rYYuSS2RG96XFqkh5hErAn_1QfE_v1wLfROgnK_70Jl97eq70g2
responses:
'200':
description: Rack type deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Rack type deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/racks:
get:
tags:
- Nodes / Racks
summary: RESTfulRacks_Get
description: Gets the racks collection.
operationId: RESTfulRacks_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
post:
tags:
- Nodes / Racks
summary: RESTfulRacks_Post
description: "
Use this node format for new rack creation:\r\n \r\n {\r\n \"name\": \"My Rack\",\r\n \"base_node\": {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010327\"\r\n },\r\n },\r\n \"rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000003399\"\r\n },\r\n \"power\": 1200,\r\n \"max_weight\": 156\r\n }"
operationId: RESTfulRacks_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: qksk8UHPDiZzZe9_mGDgyMSa5hilm5i3mQRIQy0x6uE6yp25Hmre-d0-CWY5tya8PO6qFeBdBezUc-w5xVa950hrSfdLrUBZpfcKtyc17l3UHV8mVFsWAn3b1TZd0SDErYRc4lC9wAc6GiMdvosxfQ2
requestBody:
description: New rack.
content:
application/json:
schema:
type: object
description: New rack.
required: true
responses:
'201':
description: Rack creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Other than 'Rack' base node type.
headers: {}
content: {}
'409':
description: Conflict - a new rack should not contain 'href'.
headers: {}
content: {}
'500':
description: Rack creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/racks/{id}:
get:
tags:
- Nodes / Racks
summary: RESTfulRacks_GetById
description: 'Rack id example: 24000000000123'
operationId: RESTfulRacks_GetById
parameters:
- name: id
in: path
description: Rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing rack.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Rack'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Rack'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Nodes / Racks
summary: RESTfulRacks_Put
description: "
Use this rack format for rack update:\r\n \r\n {\r\n \"name\": \"My Rack\",\r\n \"base_node\": {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010327\"\r\n },\r\n },\r\n \"rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000003399\"\r\n },\r\n \"power\": 1200,\r\n \"max_weight\": 156\r\n }"
operationId: RESTfulRacks_Put
parameters:
- name: id
in: path
description: Rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: MKgi2JndCO1Xy_JnMcMtRb4zKfGuShnOw5uiHZfObxIrTfmJY37Yky5ZxazSEXr1_JmUSQJSA2Aqr9a2MVfpj7sapumfLpuJ0n3Ga7yT54lKi83JBlICJGEVASplkAT1sXqzAxR5UvxZxHYSriHiXQ2
requestBody:
description: Updated rack.
content:
application/json:
schema:
type: object
description: Updated rack.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Nodes / Racks
summary: RESTfulRacks_Delete
description: Deletes a rack.
operationId: RESTfulRacks_Delete
parameters:
- name: id
in: path
description: Rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: FENJhIe95knjklTjNwTsny08oDhQmZjO7BlNs8267mcf8iNqqx7vbYYRD0hQ1jPKv34fFJzJ8QNwASTmnsmOTS8A2SBVA7fEXP89RcvfS9CO6B7vW95SquSxZWp2OPHhDaZiHtHUO6-9TdHJQum3Qw2
responses:
'200':
description: Rack deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Rack deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/racks/{rack_id}/containers:
get:
tags:
- Nodes / Racks
summary: RESTfulRackContainers_Get
description: Gets the rack containers collection.
operationId: RESTfulRackContainers_Get
parameters:
- name: rack_id
in: path
description: Parent rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/racks/{rack_id}/containers/{id}:
get:
tags:
- Nodes / Racks
summary: RESTfulRackContainers_GetById
description: 'Rack container id example: 39'
operationId: RESTfulRackContainers_GetById
parameters:
- name: rack_id
in: path
description: Parent rack id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Rack container id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing rack container.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainer'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.RackContainer'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/roles:
get:
tags:
- User Roles
summary: RESTfulRoles_Get
description: Gets the user roles collection.
operationId: RESTfulRoles_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/roles/{id}:
get:
tags:
- User Roles
summary: RESTfulRoles_GetById
description: 'User role id example: 13000000000003'
operationId: RESTfulRoles_GetById
parameters:
- name: id
in: path
description: User role id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing user group.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Role'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Role'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/search:
get:
tags:
- Search
summary: RESTfulSearch_Get
description: "This search endpoint returns following types of objects: Node, Rack,\r\n Device, Card, Port, FreeText, Circuit, Strand, \r\n Link, Slot"
operationId: RESTfulSearch_Get
parameters:
- name: q
in: query
description: Search query.
style: form
explode: true
schema:
type: string
- name: parent_diagram
in: query
description: Optional. Specifies a parent diagram to search on. Should contain the diagram's href.
style: form
explode: true
schema:
type: string
- name: include_subdiagrams
in: query
description: If true, includes sub diagrams when 'parent_diagram' is set.
style: form
explode: true
schema:
type: boolean
- name: exact_match
in: query
description: If true, the exact match criteria is used for searching.
style: form
explode: true
schema:
type: boolean
- name: resource_type
in: query
description: >-
Restricts search results only by resources of this object type
(see the remark for available object types).
style: form
explode: true
schema:
type: string
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: "Data expansion. Usage: 'resource' expands found resources."
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/tasks:
get:
tags:
- Work Orders / Tasks
summary: RESTfulWorkOrderTasks_Get
description: Gets the work order task's collection with no relation to a specific work order.
operationId: RESTfulWorkOrderTasks_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
/wapi/v1/work_orders/{work_order_id}/tasks:
get:
tags:
- Work Orders / Tasks
summary: GetRESTfulWorkOrderTasks_Get
description: Gets the work order task's collection.
operationId: GetRESTfulWorkOrderTasks_Get
parameters:
- name: work_order_id
in: path
description: Host work order id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Work Orders / Tasks
summary: RESTfulWorkOrderTasks_Put
description: "When altering the name parameter (renaming the work order task) the new name\r\n must be unique throughout work order tasks.\r\n
Use this work order task format for work order task update:\r\n \r\n {\r\n \"performer\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"Other Test New Name\",\r\n \"due_date\": \"2019-11-04T00:00:00\",\r\n \"comments\": \"\",\r\n \"status\": \"InPropress\",\r\n \"is_performer_notified\": true,\r\n \"is_performer_notified_about_overdue\": false,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/work_orders/1/tasks/20013\"\r\n }"
operationId: RESTfulWorkOrderTasks_Put
parameters:
- name: work_order_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: dnYV6sRe654G1vLNQ2ysfrXmBQWowH7rN0-OhrMnHY6eyzKQNqGMqJWA7kEnhCL-ofZFkndm4maYCHyH925TgBJaJUpKsiuyDsX0zLLDsw-Y60UKVag_KeFuwDZVpOT6muLD6aMbZL3t7DR_kL3_Sw2
requestBody:
description: Updated work order task.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrderTask'
- description: Updated work order task.
required: true
responses:
'200':
description: Work order task update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The work order task cannot be found.
headers: {}
content: {}
'500':
description: Work order task update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Work Orders / Tasks
summary: RESTfulWorkOrderTasks_Post
description: "New work order task name must be unique throughout work order tasks.\r\n Use this work order task format for new work order tasks creation:\r\n \r\n {\r\n \"parent_work_order\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/work_orders/1\"\r\n },\r\n \"performer\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000004\"\r\n },\r\n \"object\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000349194\"\r\n },\r\n \"name\": \"My Other Work Order\",\r\n \"due_date\": \"2018-11-04T00:00:00\",\r\n \"comments\": \"Test work order.\",\r\n \"type\": \"other\"\r\n }"
operationId: RESTfulWorkOrderTasks_Post
parameters:
- name: work_order_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: d-R69rYCdT1P6415rBEjUsdkeQccTtd2NtUAnmYb3m8l8qKSe--gYekCme5oGYpkEg1eky8pxx69HdCnXsEmdj9AHawzQa_zjApR4qdttLSGNIwF6Of1iv0mrSyS4ghUxg3tyjyH0SDCvGGbehWbcA2
requestBody:
description: New work order task.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrderTask'
- description: New work order task.
required: true
responses:
'201':
description: Work order task creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new work order task should not contain 'href'.
headers: {}
content: {}
'500':
description: Work order task creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/work_orders/{work_order_id}/tasks/{id}:
get:
tags:
- Work Orders / Tasks
summary: RESTfulWorkOrderTasks_GetById
description: 'Work order task id example: 20008'
operationId: RESTfulWorkOrderTasks_GetById
parameters:
- name: work_order_id
in: path
description: Host work order id.
required: true
style: simple
schema:
type: integer
format: int64
- name: id
in: path
description: Work order task id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing work order task.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrderTask'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrderTask'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Work Orders / Tasks
summary: RESTfulWorkOrderTasks_Delete
description: Deletes a work order task.
operationId: RESTfulWorkOrderTasks_Delete
parameters:
- name: id
in: path
description: Work order task id.
required: true
style: simple
schema:
type: integer
format: int64
- name: work_order_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: L7RJbV9ke-mgab16FXVlnxl-59hYNKzgi_Pc9CqTz-xD-Aly2JZz6UBbQK45btSZr2x7gvtcIMnJcFvQA9-r664aCAnR7Hmwy53NoliYorI_E-0SbLtJhKeYfIx14z5ortoACj6IVJGI6sB8U08K5Q2
responses:
'200':
description: Work order task deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Work order task deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/users:
get:
tags:
- Users
summary: RESTfulUsers_Get
description: Gets the netTerrain users collection.
operationId: RESTfulUsers_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Users
summary: RESTfulUsers_Put
description: "User name and type cannot be changed.\r\n
Use this user format for user update:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n \"description\": \"\",\r\n \"comments\": \"\",\r\n \"group\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/groups/12000000000008\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000021\"\r\n }"
operationId: RESTfulUsers_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: QgZ_pj0WWlXo5pKNZIlpoH28tzE5I6NeCR1S9JZyU54omU5tiMg4F7vSujMQcNlKG18wEzLgpGLM8u8MyZbHeKbLyptJnEfvvEJXpgzicoChpSlxmoOIPRSPc9Rrke2kcC4LHQ1xuW4N1TA3gpHMCg2
requestBody:
description: Updated user.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.User'
- description: Updated user.
required: true
responses:
'200':
description: User update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The user or the new user's group cannot be found.
headers: {}
content: {}
'500':
description: User update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Users
summary: RESTfulUsers_Post
description: "\r\n
Use {M:NetTerrain.Controllers.RESTfulApi.RESTfulUsersController.SetPassword(System.Int64,System.String)} method to set a password for\r\n the newly created user.\r\n Use this user format for new users creation:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n \"description\": \"\",\r\n \"comments\": \"\",\r\n \"group\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/groups/12000000000008\"\r\n }\r\n }"
operationId: RESTfulUsers_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: HElULnS8xvy9mUnr2ZraD2wNlITXXgLwwcoFPMPSR3Ghyfuplr_iCoD_pg9OrO_wgS3vHVsAGhUYtWKqY92PhIzUZs36A6npYvxLbquJslH8odsYR9X2nxQKcqkIeLqpF1f3Rf_s_eXv4YyAtv-8SQ2
requestBody:
description: New user.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.User'
- description: New user.
required: true
responses:
'201':
description: User creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new user should not contain 'href'.
headers: {}
content: {}
'500':
description: User creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/users/{id}:
get:
tags:
- Users
summary: RESTfulUsers_GetById
description: 'User id example: 94000000000002'
operationId: RESTfulUsers_GetById
parameters:
- name: id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.User'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.User'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Users
summary: PutRESTfulUsers_Put
description: "User name and type cannot be changed.\r\n
Use this user format for user update:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n \"description\": \"\",\r\n \"comments\": \"\",\r\n \"group\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/groups/12000000000008\"\r\n },\r\n }"
operationId: PutRESTfulUsers_Put
parameters:
- name: id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: GWoDEtL8H0nNe6Ir0uOxtuST1iRP-EphX6cmX4HFw7O6TY3xWu24W0JQJ3QHKOiG29oYZLnREU7zbe3s6cYpwfbOxVFYBEvBcvX_HM6bNIvtrupWB0Kp5PRFA0wQ-D0BqR8Awc3Mu-DHrKF7c-SGDQ2
requestBody:
description: Updated user.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.User'
- description: Updated user.
required: true
responses:
'200':
description: User update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The user or the new user's group cannot be found.
headers: {}
content: {}
'500':
description: User update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Users
summary: RESTfulUsers_Delete
description: >-
User id example: 94000000000032.
Service account used for API authentication cannot be deleted this way.
operationId: RESTfulUsers_Delete
parameters:
- name: id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: RxAj4VMOKHU1n5buxnAo63qL7LsGjDwcq1UtAL8Cjmvucqm6JHoYMMtbAy-PTLw1toVyStEj-o1OAaCxYRgoOfNdKlh6BvXm_-kNAZv_DvoWsdv9Hzny_bPorL6MtaQfx9qGAXZqk6vVNJZb7blMDg2
responses:
'200':
description: User deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: User deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/users/{id}/set_password:
put:
tags:
- Users
summary: RESTfulUsers_SetPassword
description: >-
Password of current the account used for API authentication cannot be changed.
Use a quoted string in the request body to represent a new password.
(The body is represented by the 'password' parameter in the following form). It must look
like this: "MyNewPassword". Including quotes! Do not use any brackets.
operationId: RESTfulUsers_SetPassword
parameters:
- name: id
in: path
description: User id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: JkxZKG3iKEyFrBzHrJgPNN8fzlK3rdsUfmg_ZusKiOoMi8UbQJ-yLPaplWPn82BK1GCuCQDhA63YGhMJmRmSiuuQLGczu8sQx-eoy3bJ027vZaEbQQix8FogWP-9hZVxyaB81CtwK67hqtnLACjU3g2
requestBody:
description: New password.
content:
application/json:
schema:
type: string
description: New password.
required: true
responses:
'200':
description: Password update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Password update failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/vendors:
get:
tags:
- Vendors
summary: RESTfulVendors_Get
description: Gets the vendors collection.
operationId: RESTfulVendors_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Vendors
summary: RESTfulVendors_Put
description: "When altering the name parameter (renaming the vendor) the new name must be\r\n unique throughout vendors.\r\n
Use this vendor format for vendor update:\r\n \r\n {\r\n \"name\": \"ACME\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/767\"\r\n }"
operationId: RESTfulVendors_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: DUZ0o92GP1j8jyc9KGlKDiJ6MyG9EXOqYAkzheTlRsNr0U4HjGAWhK51PPaqNLvhepsRnXzqpkbP6aS_jdRX_mKa755xR5PKT6RAqMe1F5S3z7ezZlXu4Xe5cNhQaoXKD1j9Qd8uNMRPj6pkWtzqYg2
requestBody:
description: Updated vendor.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Vendor'
- description: Updated vendor.
required: true
responses:
'200':
description: Vendor update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The vendor cannot be found.
headers: {}
content: {}
'500':
description: Vendor update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Vendors
summary: RESTfulVendors_Post
description: "New vendor name must be unique throughout vendors.\r\n Use this vendor format for new vendors creation:\r\n \r\n {\r\n \"name\": \"ACME\"\r\n }"
operationId: RESTfulVendors_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: BtYJ11SOhJk1cnGyiQnZXCoLNqBCpbgE0XQGftDunKN8SER-uH8rEHcMhj8FlQowmQHRKZvbzrRC3QDfYlMliDAMTvhQzS8A-vWIqQXqId00R7cDiBLgQXgGxIdYq_aiOO7id50xXl94X2PjuoCx1g2
requestBody:
description: New vendor.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Vendor'
- description: New vendor.
required: true
responses:
'201':
description: Vendor creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new vendor should not contain 'href'.
headers: {}
content: {}
'500':
description: Vendor creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/vendors/{id}:
get:
tags:
- Vendors
summary: RESTfulVendors_GetById
description: 'Vendor id example: 27000000000017'
operationId: RESTfulVendors_GetById
parameters:
- name: id
in: path
description: Vendor id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing vendor.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Vendor'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Vendor'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
put:
tags:
- Vendors
summary: PutRESTfulVendors_Put
description: "When altering the name parameter (renaming the vendor) the new name must be\r\n unique throughout vendors.\r\n
Use this vendor format for vendor update:\r\n \r\n {\r\n \"name\": \"ACME\"\r\n }"
operationId: PutRESTfulVendors_Put
parameters:
- name: id
in: path
description: Vendor id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: bIUmsvMfuq_rugXRBSLPWB9F9cPWmFuq8B854kBdJWCHVdQ02bEOUdOBS4YfqMhvDB3ZlOyVHnaMLexqCSriQ_6UYkYJzf-dyeY4uPtgPwNUSbZwjUuoaRHUYXKkNCtS7lf16xMHWeAWjH24R681WQ2
requestBody:
description: Updated vendor.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.Vendor'
- description: Updated vendor.
required: true
responses:
'200':
description: Vendor update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The vendor cannot be found.
headers: {}
content: {}
'500':
description: Vendor update failed.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Vendors
summary: RESTfulVendors_Delete
description: Vendors in use cannot be deleted.
operationId: RESTfulVendors_Delete
parameters:
- name: id
in: path
description: Vendor id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: JXDl1GEOdldYU-Al2dUFOTnCVB0PyfTtmrJE_K43ve1pVWfZqJFgeurPYRxPE6gU-g1o6KM8UpU5x4sRF2I4U4XR-2A_jd6idHq72dDvl2hf_QLvsWIZyQngS198DXEQILXJR9ysZgzSSNTgILi63A2
responses:
'200':
description: Vendor deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Vendor deletion failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/vis_links/{vis_link_id}/displayed_fields:
get:
tags:
- Links / Vis Links / Displayed Fields
summary: RESTfulVisLinkDisplayedFields_Get
description: Gets the vis link displayed fields collection.
operationId: RESTfulVisLinkDisplayedFields_Get
parameters:
- name: vis_link_id
in: path
description: Vis link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Links / Vis Links / Displayed Fields
summary: RESTfulVisLinkDisplayedFields_Put
description: "
Use this displayed field format:\r\n \r\n {\r\n \"offset_x\": 50,\r\n \"offset_y\": 50,\r\n \"anchor\": 1,\r\n \"upright_alignment\": false,\r\n \"font_size\": 12,\r\n \"color\": \"#004020\",\r\n \"background_color\": \"#AAB456\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": -34,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n \"is_italic\": true,\r\n \"is_underline\": true,\r\n \"font_family\": \"Arial\",\r\n \"align\": 1,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vis_links/7572/displayed_fields/15069\"\r\n }"
operationId: RESTfulVisLinkDisplayedFields_Put
parameters:
- name: vis_link_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: V3fz7iT6OF3xz2tgHdnQsk9DNTNu55F3HqLr-qulYHPgzUYzNRUIUyfkqlRSwsAHWxvlewlkR2qJp0zFt-W9zg8VH--VESh79EtQPmkgXCtIeSM4z6g_yMURigjghQicSivC195WPuMjE_omuAmL_w2
requestBody:
description: Updated displayed field.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkDisplayedField'
- description: Updated displayed field.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Links / Vis Links / Displayed Fields
summary: RESTfulVisLinkDisplayedFields_Post
description: "
Use this format for displayed field creation:\r\n \r\n {\r\n \"parent_vis_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000007415/vis_links/7572\"\r\n },\r\n \"parent_link_property_value\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000007415/link_property_values/15069\"\r\n },\r\n \"offset_x\": 70,\r\n \"offset_y\": 70,\r\n \"anchor\": 1,\r\n \"upright_alignment\": false,\r\n \"font_size\": 16,\r\n \"color\": \"#004020\",\r\n \"background_color\": \"#AAB456\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": 34,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n \"is_italic\": true,\r\n \"is_underline\": true,\r\n \"font_family\": \"Arial\",\r\n \"align\": 1\r\n }"
operationId: RESTfulVisLinkDisplayedFields_Post
parameters:
- name: vis_link_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: VbMKcoJb2QSLkpTLxIIo-2fh7XKy8q2pkA5E7GpIVkrOgXM8tJkJYPpBgnDI97W1QXcxNUBdoKJdcARtAckGuHQ6g2KslI3nUpkkE3DvYqD9AAQq91ZAk9U0r_3wV7UyoayqibZnNb0tNS9l1FlT9Q2
requestBody:
description: New displayed field.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkDisplayedField'
- description: New displayed field.
required: true
responses:
'201':
description: Displayed field creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new displayed field should not contain 'href'.
headers: {}
content: {}
'500':
description: Displayed field creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/vis_links/{vis_link_id}/displayed_fields/{link_property_value_id}:
get:
tags:
- Links / Vis Links / Displayed Fields
summary: RESTfulVisLinkDisplayedFields_GetById
description: Gets the vis link displayed field value.
operationId: RESTfulVisLinkDisplayedFields_GetById
parameters:
- name: link_property_value_id
in: path
description: Link property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: vis_link_id
in: path
description: Vis link id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing link property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkDisplayedField'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.LinkDisplayedField'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/vis_nodes/{vis_node_id}/displayed_fields:
get:
tags:
- Nodes / Vis Nodes / Displayed Fields
summary: RESTfulVisNodeDisplayedFields_Get
description: Gets the vis node displayed fields collection.
operationId: RESTfulVisNodeDisplayedFields_Get
parameters:
- name: vis_node_id
in: path
description: Vis node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Nodes / Vis Nodes / Displayed Fields
summary: RESTfulVisNodeDisplayedFields_Put
description: "
Use this displayed field format:\r\n \r\n {\r\n \"offset_x\": 10,\r\n \"offset_y\": -25,\r\n \"font_size\": 12,\r\n \"color\": \"#450450\",\r\n \"background_color\": \"#AAAAAA\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": 278,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n \"is_italic\": true,\r\n \"is_underline\": true,\r\n \"font_family\": \"Lucida Console\",\r\n \"align\": 0\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vis_nodes/26341/displayed_fields/82762\"\r\n }\r\n }"
operationId: RESTfulVisNodeDisplayedFields_Put
parameters:
- name: vis_node_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: Bh5q0NAWXHLCBub4p-fmkXBHUrkNWp1K9pAssdQAdGj1PZku0a3gBta7MFjw74tBjt1pV3tZ4pl1bY-ckjY504W4ewoiu1FUZ1qD0NTjpu1cBiX0gRD-ug-m-b3hA9pduNS_5LZJ3r7tGE2pY2Mm-A2
requestBody:
description: Updated displayed field.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeDisplayedField'
- description: Updated displayed field.
required: true
responses:
'200':
description: Update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The resource cannot be found.
headers: {}
content: {}
'500':
description: Update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Nodes / Vis Nodes / Displayed Fields
summary: RESTfulVisNodeDisplayedFields_Post
description: "
Use this format for displayed field creation:\r\n \r\n {\r\n \"parent_vis_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028497/vis_nodes/26341\"\r\n },\r\n \"parent_node_property_value\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028497/node_property_values/82769\"\r\n },\r\n \"offset_x\": 10,\r\n \"offset_y\": -25,\r\n \"font_size\": 12,\r\n \"color\": \"#450450\",\r\n \"background_color\": \"#AAAAAA\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": 278,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n \"is_italic\": true,\r\n \"is_underline\": true,\r\n \"font_family\": \"Lucida Console\",\r\n \"align\": 0\r\n }"
operationId: RESTfulVisNodeDisplayedFields_Post
parameters:
- name: vis_node_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: BChKCnbvMshnV_NWoQ0K2CMTF8Z58Q5df1sXw47qZhKW6cIhFW-MNW7kwy27DrkEspULfZZaq8ID7Gyq9TLIeyldYLnEBKtzhiErP3CW2sxokFO1LCY9W0vsmaHzRUIDlxm237jkREqnwHD8_kfdJA2
requestBody:
description: New displayed field.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeDisplayedField'
- description: New displayed field.
required: true
responses:
'201':
description: Displayed field creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new displayed field should not contain 'href'.
headers: {}
content: {}
'500':
description: Displayed field creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/vis_nodes/{vis_node_id}/displayed_fields/{node_property_value_id}:
get:
tags:
- Nodes / Vis Nodes / Displayed Fields
summary: RESTfulVisNodeDisplayedFields_GetById
description: Gets the vis node displayed field value.
operationId: RESTfulVisNodeDisplayedFields_GetById
parameters:
- name: node_property_value_id
in: path
description: Node property value id.
required: true
style: simple
schema:
type: integer
format: int64
- name: vis_node_id
in: path
description: Vis node id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing node property value.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeDisplayedField'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.NodeDisplayedField'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
/wapi/v1/work_orders:
get:
tags:
- Work Orders
summary: RESTfulWorkOrders_Get
description: Gets the work order's collection.
operationId: RESTfulWorkOrders_Get
parameters:
- name: page
in: query
description: Collection page number starting from 1.
style: form
explode: true
schema:
type: integer
format: int32
- name: per_page
in: query
description: Resources per page.
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Resources to skip before the first page starts.
style: form
explode: true
schema:
type: integer
format: int32
- name: expand
in: query
description: >-
Data expansion. Usage:
'self' expands collection items,
'self,child_resource_name,...' also expands child resources with names set.
'self,all_children' also expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Success.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
deprecated: false
put:
tags:
- Work Orders
summary: RESTfulWorkOrders_Put
description: "When altering the name parameter (renaming the work order) the new name must be\r\n unique throughout work orders.\r\n
Use this work order format for work order update:\r\n \r\n {\r\n \"owner\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"WO#3-Urgent!\",\r\n \"due_date\": \"2019-02-01\",\r\n \"comments\": \"Urgent!\",\r\n \"is_archived\": false,\r\n \"is_owner_notified\": false,\r\n \"is_owner_notified_about_overdue\": false,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/work_orders/3\"\r\n }"
operationId: RESTfulWorkOrders_Put
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: f6X1pXizezQu4q658QaOffwASDkycStxZkkjj83aVf00osAlKrYBMNTzXBWYaxtmAwG2RJc-lIYFvAPtaki8GnnhAKS-n_wKS4j99W50ffK5VeQHe_Hu_Uj6_GNhLt-EZ8jJVhV_tcmBziIpWME9Ww2
requestBody:
description: Updated work order.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrder'
- description: Updated work order.
required: true
responses:
'200':
description: Work order update successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'400':
description: Bad request - no input data.
headers: {}
content: {}
'404':
description: The work order cannot be found.
headers: {}
content: {}
'500':
description: Work order update failed.
headers: {}
content: {}
deprecated: false
post:
tags:
- Work Orders
summary: RESTfulWorkOrders_Post
description: "New work order name must be unique throughout work orders.\r\n Use this work order format for new work orders creation:\r\n \r\n {\r\n \"owner\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"WO#1\",\r\n \"due_date\": \"2019-04-18\",\r\n \"comments\": \"New work order\"\r\n }"
operationId: RESTfulWorkOrders_Post
parameters:
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: 2_DI1tkqfK9BTFiUYueNgVzIY03uXa_g4VOkGv0yEOPFx8LaUCvsK8q-3CL_t1rNLJP_ba8kvtdVzwkjKRFrxGRECRDFu--JFWWzaVx1w2tXtPxv_XxTEUALgG1pwf1i1K4iWENpbndUifsqPQI8pw2
requestBody:
description: New work order.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrder'
- description: New work order.
required: true
responses:
'201':
description: Work order creation successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'409':
description: Conflict - a new work order should not contain 'href'.
headers: {}
content: {}
'500':
description: Work order creation failed.
headers: {}
content: {}
deprecated: false
/wapi/v1/work_orders/{id}:
get:
tags:
- Work Orders
summary: RESTfulWorkOrders_GetById
description: 'Work order id example: 7'
operationId: RESTfulWorkOrders_GetById
parameters:
- name: id
in: path
description: Work order id.
required: true
style: simple
schema:
type: integer
format: int64
- name: expand
in: query
description: >-
Data expansion. Usage:
'child_resource_name,...' expands child resources with names set.
'all_children' expands all child resources.
style: form
explode: true
schema:
type: string
- name: show_child_collections
in: query
description: >-
If unset or set to false all unexpanded child
collections contain just a single "href" link. Otherwise they also contain basic collection
info.
style: form
explode: true
schema:
type: boolean
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
responses:
'200':
description: Returns the existing work order.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrder'
text/json:
schema:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.WorkOrder'
'404':
description: Resource does not exist.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Work Orders
summary: RESTfulWorkOrders_Delete
description: Work orders in use cannot be deleted.
operationId: RESTfulWorkOrders_Delete
parameters:
- name: id
in: path
description: Work order id.
required: true
style: simple
schema:
type: integer
format: int64
- name: swagger_request
in: header
description: ''
style: simple
schema:
type: string
default: 'true'
- name: __RequestVerificationToken
in: header
description: ''
style: simple
schema:
type: string
default: VAwGcW4d7u_KPP-ZN5LHKUNDoWV_gdB0JhP93EScgrshIpypT91gCEn-3ycXLpAaJTS5O-R1rz1_zQpNsXsm1R9SPblJbuR_ecDUadzU95GM2npNoLgKC7QsgSClTuPZ48nHzbiI4FJSTSVFWwssmQ2
responses:
'200':
description: Work order deletion successful.
headers: {}
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'500':
description: Work order deletion failed.
headers: {}
content: {}
deprecated: false
components:
schemas:
NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel:
title: NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel
type: object
properties:
href:
type: string
NetTerrain.Models.RESTfulApi.Card:
title: NetTerrain.Models.RESTfulApi.Card
type: object
properties:
parent:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
base_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slot_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
card_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
peak_power:
type: number
weight:
type: number
status:
type: string
cards:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slots:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
ports:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.CardType:
title: NetTerrain.Models.RESTfulApi.CardType
type: object
properties:
base_node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
background:
type: string
peak_power:
type: number
weight:
type: number
physical_height:
type: number
physical_width:
type: number
vendor:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
port_representations:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slot_representations:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
mapped_to:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.CircuitProperty:
title: NetTerrain.Models.RESTfulApi.CircuitProperty
type: object
properties:
name:
type: string
is_system:
type: boolean
show_in_acra:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.CircuitPropertyValue:
title: NetTerrain.Models.RESTfulApi.CircuitPropertyValue
type: object
properties:
name:
type: string
parent_circuit:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
circuit_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.Circuit:
title: NetTerrain.Models.RESTfulApi.Circuit
type: object
properties:
name:
type: string
from_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
to_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
circuit_property_values:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Device:
title: NetTerrain.Models.RESTfulApi.Device
type: object
properties:
base_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
parent_rack_container:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
device_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
peak_power:
type: number
weight:
type: number
status:
type: string
container_position:
type: number
rack_units_occupied:
type: number
cards:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slots:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
ports:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.DeviceType:
title: NetTerrain.Models.RESTfulApi.DeviceType
type: object
properties:
system_object_id:
type: string
in_stock:
type: integer
format: int32
base_node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
background:
type: string
peak_power:
type: number
weight:
type: number
physical_height:
type: number
physical_width:
type: number
vendor:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
port_representations:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slot_representations:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.DiagramSettings:
title: NetTerrain.Models.RESTfulApi.DiagramSettings
type: object
properties:
url:
type: string
background:
type: string
is_template:
type: boolean
template:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
page_color:
type: string
diagram_width:
type: number
diagram_height:
type: number
diagram_margin_size:
type: number
is_blocked:
type: boolean
visibility_layers_settings:
type: string
auto_layout_state:
type: integer
format: int32
map_coord_left:
type: number
map_coord_top:
type: number
map_coord_right:
type: number
map_coord_bottom:
type: number
map_units_type:
type: integer
format: int32
map_source:
type: integer
format: int32
is_display_grid:
type: boolean
is_snap_to_grid:
type: boolean
grid_spacing_x:
type: number
grid_spacing_y:
type: number
read_only_for_non_admins:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.FreeText:
title: NetTerrain.Models.RESTfulApi.FreeText
type: object
properties:
parent_diagram:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
creator:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
master_free_text:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
displayed_value:
type: string
x:
type: number
y:
type: number
z_order:
type: integer
format: int32
is_alias:
type: boolean
font_size:
type: number
color:
type: string
background_color:
type: string
justification:
type: integer
format: int32
can_move:
type: boolean
angle:
type: integer
format: int32
is_displayed:
type: boolean
is_bold:
type: boolean
is_italic:
type: boolean
is_underline:
type: boolean
font_family:
type: string
align:
type: integer
format: int32
href:
type: string
NetTerrain.Models.RESTfulApi.Group:
title: NetTerrain.Models.RESTfulApi.Group
type: object
properties:
name:
type: string
is_system:
type: boolean
role:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.LinkCategory:
title: NetTerrain.Models.RESTfulApi.LinkCategory
type: object
properties:
parent_link_category:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
image:
type: string
is_favorite:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.LinkOverride:
title: NetTerrain.Models.RESTfulApi.LinkOverride
type: object
properties:
parent_link_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
rule:
$ref: '#/components/schemas/Rule'
is_override:
type: boolean
thickness:
type: number
link_style:
$ref: '#/components/schemas/LinkStyle'
start_arrow:
$ref: '#/components/schemas/StartArrow'
end_arrow:
$ref: '#/components/schemas/EndArrow'
color:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.LinkPropertyValue:
title: NetTerrain.Models.RESTfulApi.LinkPropertyValue
type: object
properties:
name:
type: string
parent_link:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
link_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
displayed_value:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.Link:
title: NetTerrain.Models.RESTfulApi.Link
type: object
properties:
name:
type: string
link_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
from_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
to_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
link_property_values:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
vis_links:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.LinkTypeProperty:
title: NetTerrain.Models.RESTfulApi.LinkTypeProperty
type: object
properties:
name:
type: string
parent_link_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
link_overrides:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
is_system:
type: boolean
default_value:
type: string
position:
type: integer
format: int32
is_mandatory:
type: boolean
is_displayed:
type: boolean
is_in_properties:
type: boolean
text_justification:
$ref: '#/components/schemas/TextJustification'
text_align:
$ref: '#/components/schemas/TextAlign'
font_family:
$ref: '#/components/schemas/FontFamily'
font_size:
type: number
font_color:
type: string
fill_color:
type: string
offset_x:
type: number
offset_y:
type: number
angle:
type: integer
format: int32
is_bold:
type: boolean
is_italic:
type: boolean
is_underlined:
type: boolean
is_lock_list:
type: boolean
is_type_field:
type: boolean
is_unique_for_this_type:
type: boolean
is_unique_for_all_types:
type: boolean
is_upright_alignment:
type: boolean
anchor:
$ref: '#/components/schemas/Anchor'
href:
type: string
NetTerrain.Models.RESTfulApi.LinkType:
title: NetTerrain.Models.RESTfulApi.LinkType
type: object
properties:
name:
type: string
is_favorite:
type: boolean
is_system:
type: boolean
is_enabled:
type: boolean
is_snapped_to_edge:
type: boolean
is_matching_port_connectors:
type: boolean
thickness:
type: number
link_style:
$ref: '#/components/schemas/LinkStyle'
start_arrow:
$ref: '#/components/schemas/StartArrow'
end_arrow:
$ref: '#/components/schemas/EndArrow'
color:
type: string
link_category:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
link_type_properties:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.NodeCategory:
title: NetTerrain.Models.RESTfulApi.NodeCategory
type: object
properties:
parent_node_category:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
image:
type: string
node_type_group:
$ref: '#/components/schemas/NodeTypeGroup'
is_favorite:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.MapCoordinates:
title: NetTerrain.Models.RESTfulApi.MapCoordinates
type: object
properties:
x:
type: number
y:
type: number
units:
$ref: '#/components/schemas/Units'
href:
type: string
NetTerrain.Models.RESTfulApi.NodeOverride:
title: NetTerrain.Models.RESTfulApi.NodeOverride
type: object
properties:
parent_node_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
rule:
$ref: '#/components/schemas/Rule'
is_override:
type: boolean
image:
type: string
instance_effect:
$ref: '#/components/schemas/InstanceEffect'
parent_effect:
$ref: '#/components/schemas/ParentEffect'
upwards_propagation:
$ref: '#/components/schemas/UpwardsPropagation'
href:
type: string
NetTerrain.Models.RESTfulApi.NodePropertyValue:
title: NetTerrain.Models.RESTfulApi.NodePropertyValue
type: object
properties:
name:
type: string
parent_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
value:
type: string
displayed_value:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.Node:
title: NetTerrain.Models.RESTfulApi.Node
type: object
properties:
name:
type: string
parent_diagram:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
creator:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
master_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
diagram_settings:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_property_values:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
vis_nodes:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
map_coordinates:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
aliases:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
double_click_behavior:
type: string
is_alias:
type: boolean
breadcrumbs:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.VisLinksSeparationData:
title: NetTerrain.Models.RESTfulApi.VisLinksSeparationData
type: object
properties:
node_1:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_2:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
distance:
type: number
bend_points_number:
type: integer
format: int32
is_curved:
type: boolean
NetTerrain.Models.RESTfulApi.NodeTypeProperty:
title: NetTerrain.Models.RESTfulApi.NodeTypeProperty
type: object
properties:
name:
type: string
parent_node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_overrides:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
is_system:
type: boolean
default_value:
type: string
position:
type: integer
format: int32
is_mandatory:
type: boolean
is_displayed:
type: boolean
is_in_properties:
type: boolean
text_justification:
$ref: '#/components/schemas/TextJustification'
text_align:
$ref: '#/components/schemas/TextAlign'
font_family:
$ref: '#/components/schemas/FontFamily'
font_size:
type: number
font_color:
type: string
fill_color:
type: string
offset_x:
type: number
offset_y:
type: number
angle:
type: integer
format: int32
is_bold:
type: boolean
is_italic:
type: boolean
is_underlined:
type: boolean
is_lock_list:
type: boolean
is_type_field:
type: boolean
is_unique_for_this_type:
type: boolean
is_unique_for_all_types:
type: boolean
is_not_editable:
type: boolean
system_object_id:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.NodeType:
title: NetTerrain.Models.RESTfulApi.NodeType
type: object
properties:
name:
type: string
image:
type: string
default_height:
type: number
default_width:
type: number
node_type_group:
$ref: '#/components/schemas/NodeTypeGroup'
is_favorite:
type: boolean
is_system:
type: boolean
is_enabled:
type: boolean
description:
type: string
is_keep_aspect_ratio:
type: boolean
double_click_behavior:
$ref: '#/components/schemas/DoubleClickBehavior'
double_click_behavior_attribute:
type: string
template:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
hierarchy_browser_label:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_category:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_type_properties:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.PortField:
title: NetTerrain.Models.RESTfulApi.PortField
type: object
properties:
parent_port_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
is_reference_port:
type: boolean
node_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
value:
type: string
text_justification:
$ref: '#/components/schemas/TextJustification'
text_align:
$ref: '#/components/schemas/TextAlign'
font_family:
$ref: '#/components/schemas/FontFamily'
font_size:
type: number
font_color:
type: string
fill_color:
type: string
offset_x:
type: number
offset_y:
type: number
angle:
type: integer
format: int32
is_bold:
type: boolean
is_italic:
type: boolean
is_underlined:
type: boolean
is_displayed:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.PortRepresentation:
title: NetTerrain.Models.RESTfulApi.PortRepresentation
type: object
properties:
parent_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
x:
type: number
y:
type: number
width:
type: number
height:
type: number
angle:
type: integer
format: int32
anchor_point_x:
type: number
anchor_point_y:
type: number
ref_x:
type: number
ref_y:
type: number
ref_width:
type: number
ref_height:
type: number
ref_angle:
type: integer
format: int32
ref_anchor_point_x:
type: number
ref_anchor_point_y:
type: number
bendpoint_path:
type: string
is_hidden:
type: boolean
port_fields:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Port:
title: NetTerrain.Models.RESTfulApi.Port
type: object
properties:
name:
type: string
parent_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
port_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_property_values:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
links:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.RackContainerDesign:
title: NetTerrain.Models.RESTfulApi.RackContainerDesign
type: object
properties:
parent_rack_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
rack_units_capacity:
type: integer
format: int32
rack_position_order:
$ref: '#/components/schemas/RackPositionOrder'
physical_height:
type: number
physical_width:
type: number
x:
type: number
y:
type: number
width:
type: number
height:
type: number
href:
type: string
NetTerrain.Models.RESTfulApi.RackContainer:
title: NetTerrain.Models.RESTfulApi.RackContainer
type: object
properties:
parent_rack:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
rack_container_design:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
mounted_devices:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Rack:
title: NetTerrain.Models.RESTfulApi.Rack
type: object
properties:
base_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
rack_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
available_rack_units:
type: number
power:
type: number
power_used:
type: number
max_weight:
type: number
weight_used:
type: number
rack_containers:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.RackType:
title: NetTerrain.Models.RESTfulApi.RackType
type: object
properties:
base_node_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
background:
type: string
rack_units_capacity:
type: integer
format: int32
power:
type: number
max_weight:
type: number
is_display_rack_lines:
type: boolean
in_stock:
type: integer
format: int32
vendor:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
rack_container_designs:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Role:
title: NetTerrain.Models.RESTfulApi.Role
type: object
properties:
name:
type: string
permissions:
$ref: '#/components/schemas/Permissions'
href:
type: string
NetTerrain.Models.RESTfulApi.SlotField:
title: NetTerrain.Models.RESTfulApi.SlotField
type: object
properties:
parent_slot_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
node_type_property:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
value:
type: string
text_justification:
$ref: '#/components/schemas/TextJustification'
text_align:
$ref: '#/components/schemas/TextAlign'
font_family:
$ref: '#/components/schemas/FontFamily'
font_size:
type: number
font_color:
type: string
fill_color:
type: string
offset_x:
type: number
offset_y:
type: number
angle:
type: integer
format: int32
is_bold:
type: boolean
is_italic:
type: boolean
is_underlined:
type: boolean
is_displayed:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.SlotMapping:
title: NetTerrain.Models.RESTfulApi.SlotMapping
type: object
properties:
slot_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
card_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.SlotRepresentation:
title: NetTerrain.Models.RESTfulApi.SlotRepresentation
type: object
properties:
parent_type:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
x:
type: number
y:
type: number
width:
type: number
height:
type: number
angle:
type: integer
format: int32
slot_mapping:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slot_fields:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Slot:
title: NetTerrain.Models.RESTfulApi.Slot
type: object
properties:
parent:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
base_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
slot_representation:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.User:
title: NetTerrain.Models.RESTfulApi.User
type: object
properties:
is_override_ad_group:
type: boolean
name:
type: string
is_locked:
type: boolean
account_type:
$ref: '#/components/schemas/AccountType'
email:
type: string
description:
type: string
comments:
type: string
group:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
href:
type: string
NetTerrain.Models.RESTfulApi.Vendor:
title: NetTerrain.Models.RESTfulApi.Vendor
type: object
properties:
name:
type: string
href:
type: string
NetTerrain.Models.RESTfulApi.LinkDisplayedField:
title: NetTerrain.Models.RESTfulApi.LinkDisplayedField
type: object
properties:
parent_vis_link:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
parent_link_property_value:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
offset_x:
type: number
offset_y:
type: number
anchor:
type: integer
format: int32
upright_alignment:
type: boolean
font_size:
type: number
color:
type: string
background_color:
type: string
justification:
type: integer
format: int32
can_move:
type: boolean
angle:
type: integer
format: int32
is_displayed:
type: boolean
is_bold:
type: boolean
is_italic:
type: boolean
is_underline:
type: boolean
font_family:
type: string
align:
type: integer
format: int32
href:
type: string
NetTerrain.Models.RESTfulApi.VisLink:
title: NetTerrain.Models.RESTfulApi.VisLink
type: object
properties:
parent_diagram:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
displayed_fields:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
is_curved:
type: boolean
bend_points_path:
type: string
from_anchor_point_x:
type: number
from_anchor_point_y:
type: number
to_anchor_point_x:
type: number
to_anchor_point_y:
type: number
can_move:
type: boolean
can_delete:
type: boolean
is_hidden:
type: boolean
is_snapped_to_edge:
type: boolean
z_order:
type: integer
format: int32
href:
type: string
NetTerrain.Models.RESTfulApi.NodeDisplayedField:
title: NetTerrain.Models.RESTfulApi.NodeDisplayedField
type: object
properties:
parent_vis_node:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
parent_node_property_value:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
offset_x:
type: number
offset_y:
type: number
font_size:
type: number
color:
type: string
background_color:
type: string
justification:
type: integer
format: int32
can_move:
type: boolean
angle:
type: integer
format: int32
is_displayed:
type: boolean
is_bold:
type: boolean
is_italic:
type: boolean
is_underline:
type: boolean
font_family:
type: string
align:
type: integer
format: int32
href:
type: string
NetTerrain.Models.RESTfulApi.VisNode:
title: NetTerrain.Models.RESTfulApi.VisNode
type: object
properties:
parent_diagram:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
displayed_fields:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
visual_override:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
is_reference_node:
type: boolean
x:
type: number
y:
type: number
width:
type: number
height:
type: number
image_override:
type: string
is_keep_aspect_ratio:
type: boolean
can_move:
type: boolean
can_resize:
type: boolean
can_rotate:
type: boolean
can_delete:
type: boolean
is_hidden:
type: boolean
z_order:
type: integer
format: int32
angle:
type: integer
format: int32
href:
type: string
NetTerrain.Models.RESTfulApi.WorkOrder:
title: NetTerrain.Models.RESTfulApi.WorkOrder
type: object
properties:
owner:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
due_date:
type: string
format: date-time
comments:
type: string
is_archived:
type: boolean
is_owner_notified:
type: boolean
is_owner_notified_about_overdue:
type: boolean
href:
type: string
NetTerrain.Models.RESTfulApi.WorkOrderTask:
title: NetTerrain.Models.RESTfulApi.WorkOrderTask
type: object
properties:
parent_work_order:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
performer:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
object:
$ref: '#/components/schemas/NetTerrain.Models.RESTfulApi.BaseRESTfulApiModel'
name:
type: string
due_date:
type: string
format: date-time
comments:
type: string
type:
$ref: '#/components/schemas/Type'
status:
$ref: '#/components/schemas/Status'
is_performer_notified:
type: boolean
is_performer_notified_about_overdue:
type: boolean
href:
type: string
AccountType:
title: AccountType
enum:
- 0
- 1
- 3
type: integer
Anchor:
title: Anchor
enum:
- 0
- 1
- 2
type: integer
DoubleClickBehavior:
title: DoubleClickBehavior
enum:
- 0
- 1
- 2
- 3
type: integer
EndArrow:
title: EndArrow
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- -2
- -1
type: integer
FontFamily:
title: FontFamily
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
type: integer
InstanceEffect:
title: InstanceEffect
enum:
- 0
- 1
- 2
- 3
- 4
- 5
type: integer
LinkStyle:
title: LinkStyle
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
NodeTypeGroup:
title: NodeTypeGroup
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
type: integer
ParentEffect:
title: ParentEffect
enum:
- 0
- 1
- 2
- 3
- 4
- 5
type: integer
Permissions:
title: Permissions
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- -1
type: integer
RackPositionOrder:
title: RackPositionOrder
enum:
- 0
- 1
type: integer
Rule:
title: Rule
enum:
- 0
- 1
- 4
- 5
- -1
type: integer
StartArrow:
title: StartArrow
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- -2
- -1
type: integer
Status:
title: Status
enum:
- 0
- 1
- 2
- 3
- 4
- 5
type: integer
TextAlign:
title: TextAlign
enum:
- 0
- 1
- 2
type: integer
TextJustification:
title: TextJustification
enum:
- 0
- 1
type: integer
Type:
title: Type
enum:
- 0
- 1
- 2
type: integer
Units:
title: Units
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
type: integer
UpwardsPropagation:
title: UpwardsPropagation
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
securitySchemes:
basic:
type: http
description: Basic HTTP Authentication
scheme: basic
security: []
tags:
- name: Nodes / Cards
description: ''
- name: Nodes / Ports
description: ''
- name: Links
description: ''
- name: Nodes / Slots
description: ''
- name: Node Types / Port Representations
description: ''
- name: Node Types / Port Representations / Port Fields
description: ''
- name: Node Types / Slot Representations
description: ''
- name: Node Types / Slot Representations / Slot Fields
description: ''
- name: Node Types / Slot Representations / Slot Mappings
description: ''
- name: Node Types / Card Types
description: ''
- name: Circuit Properties
description: ''
- name: Circuits / Property Values
description: ''
- name: Circuits
description: ''
- name: Node Types / Device Types
description: ''
- name: Nodes / Devices
description: ''
- name: Free Text
description: ''
- name: User Groups
description: ''
- name: Nodes / Hierarchy
description: ''
- name: Import / Device Type Query
description: ''
- name: Link Categories
description: ''
- name: Link Types / Properties / Overrides
description: ''
- name: Links / Property Values
description: ''
- name: Link Types / Properties
description: ''
- name: Link Types
description: ''
- name: Links / Vis Links
description: ''
- name: Node Categories
description: ''
- name: Node Types / Properties / Overrides
description: ''
- name: Nodes / Property Values
description: ''
- name: Node Types / Properties
description: ''
- name: Node Types
description: ''
- name: Nodes
description: ''
- name: Nodes / Diagram settings
description: ''
- name: Nodes / Map coordinates
description: ''
- name: Nodes / Vis Nodes
description: ''
- name: Node Types / Racks Types / Container Designs
description: ''
- name: Node Types / Rack Types
description: ''
- name: Nodes / Racks
description: ''
- name: User Roles
description: ''
- name: Search
description: ''
- name: Work Orders / Tasks
description: ''
- name: Users
description: ''
- name: Vendors
description: ''
- name: Links / Vis Links / Displayed Fields
description: ''
- name: Nodes / Vis Nodes / Displayed Fields
description: ''
- name: Work Orders
description: ''