@itentialopensource/adapter-nokia_nsp_network
Version:
This adapter integrates with system described as: networkSupervisionRestApis.
1,614 lines (1,613 loc) • 316 kB
JSON
{
"id": "@itentialopensource/adapter-nokia_nsp_network",
"type": "Adapter",
"export": "NokiaNspNetwork",
"title": "Nokia_nsp_network",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name" : "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type" : "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
},
{
"name": "persistFlag",
"type": "boolean",
"info": "Whether the input properties should be saved",
"required": true,
"schema": {
"title": "persistFlag",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the IAP database",
"description": "Moves entities from an adapter into the IAP database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "getCardSlotsUsingGET",
"summary": "getCardSlotsUsingGET",
"description": "Returns a paged list of specific card slots. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card slot. Each card slot contains a link to the installed card, if not empty. Not providing a filter will return all card slots. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friend...(description truncated)",
"input": [
{
"name": "fdns",
"type": "string",
"info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string",
"required": false,
"schema": {
"title": "fdns",
"type": "string"
}
},
{
"name": "filter",
"type": "string",
"info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string",
"required": false,
"schema": {
"title": "filter",
"type": "string"
}
},
{
"name": "limit",
"type": "number",
"info": "The limit on the number of objects returned (max: 1000): 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "offset",
"type": "number",
"info": "Start row for paged data (max: total number of objects): 123",
"required": false,
"schema": {
"title": "offset",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "array",
"default": "",
"items": {
"title": "CardSlot",
"type": "object",
"properties": {
"links": {
"xml": {
"namespace": "http://www.w3.org/2005/Atom",
"attribute": false,
"wrapped": false
},
"type": "array",
"items": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"xml": {
"name": "href",
"attribute": true,
"wrapped": false
},
"type": "string"
},
"rel": {
"xml": {
"name": "rel",
"attribute": true,
"wrapped": false
},
"type": "string"
},
"templated": {
"type": "boolean"
}
}
}
},
"fdn": {
"description": "The Fully Distinguished Name of this Card Slot.",
"type": "string"
},
"sourceType": {
"type": "object",
"allOf": [
{
"title": "SourceType2",
"description": "The type of the source system where this Card Slot is sourced from.",
"example": "nfmp",
"type": "string",
"enum": [
"other",
"nsd",
"nfmp",
"nfmt",
"nrcp",
"nrct",
"nrcf",
"nrcx",
"mdm",
"nsp"
]
},
{
"description": "The type of the source system where this Card Slot is sourced from."
}
]
},
"sourceSystem": {
"description": "The source system where this Card Slot is sourced from.",
"type": "string"
},
"sources": {
"description": "The Fully Distinguished Names of the Card Slots from the source system associated to this Card Slot.",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "The name of this Card Slot, as defined by the source system.",
"type": "string"
},
"neName": {
"description": "The name of the Network Element containing this Card Slot, as defined by the source system.",
"type": "string"
},
"neId": {
"description": "The id of the Network Element containing this Card Slot, as defined by the source system.",
"type": "string"
},
"description": {
"description": "The detailed description of this Card Slot.",
"type": "string"
},
"positionId": {
"description": "The relative position of the Card Slot, that determines the order in which to show it in the source system UI.",
"type": "integer"
},
"position": {
"description": "A formatted name that describes the position of the Card Slot within the Network Element.",
"type": "string"
},
"adminState": {
"type": "object",
"allOf": [
{
"title": "AdminState1",
"description": "The administrative state of this Card Slot. Refer to the X.731 standard.",
"example": "unlocked",
"type": "string",
"enum": [
"unknown",
"unlocked",
"locked",
"forcedLockout",
"shuttingDown",
"maintenance"
]
},
{
"description": "The administrative state of this Card Slot. Refer to the X.731 standard."
}
]
},
"operState": {
"type": "object",
"allOf": [
{
"title": "OperState1",
"description": "The operational state of this Card Slot. Refer to the X.731 standard.",
"example": "enabled",
"type": "string",
"enum": [
"unknown",
"enabled",
"disabled"
]
},
{
"description": "The operational state of this Card Slot. Refer to the X.731 standard."
}
]
},
"standbyState": {
"type": "object",
"allOf": [
{
"title": "StandbyState1",
"description": "The standby state of this Card Slot. Refer to the X.731 standard.",
"example": "providingService",
"type": "string",
"enum": [
"providingService",
"standby"
]
},
{
"description": "The standby state of this Card Slot. Refer to the X.731 standard."
}
]
},
"availabilityStates": {
"description": "The availability states of this Card Slot. Refer to the X.731 standard.",
"type": "array",
"items": {
"title": "AvailabilityState",
"type": "string",
"enum": [
"unknown",
"inTest",
"failed",
"degraded",
"offLine",
"powerOff",
"offDuty",
"dependency",
"notInstalled",
"logFull"
]
}
},
"stateReasons": {
"description": "A set of specific reasons why the Card Slot is in this state.",
"type": "array",
"items": {
"type": "string"
}
},
"objectDetails": {
"description": "Generic properties of this Card Slot, specific to the Network Supervision application.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"manufacturer": {
"description": "The vendor of the Card Slot.",
"type": "string"
},
"serialNumber": {
"description": "The serial number of the Card Slot provided by the manufacturer.",
"type": "string"
},
"partNumber": {
"description": "The part number of the Card Slot provided by the manufacturer.",
"type": "string"
},
"manufacturerAssemblyNumber": {
"description": "The assembly number of the Card Slot provided by the manufacturer.",
"type": "string"
},
"manufactureDate": {
"description": "The date of manufacture of the Card Slot.",
"type": "string"
},
"manufacturingDeviations": {
"description": "The manufacturing deviations of the Card Slot provided by the manufacturer.",
"type": "string"
},
"macAddress": {
"description": "The Base MAC Address of the Card Slot",
"type": "string"
},
"hwMacAddress": {
"description": "The Hardware MAC Address of the Card Slot",
"type": "string"
},
"provisionedType": {
"description": "The type of Card provisioned in this Card Slot.",
"type": "string"
},
"actualType": {
"description": "The type of Card present in this Card Slot.",
"type": "string"
},
"holderState": {
"description": "The status of the Card Slot.",
"type": "string"
}
},
"required": [
"fdn",
"sourceType",
"sourceSystem",
"sources",
"name",
"neName",
"neId",
"positionId",
"position",
"adminState",
"operState",
"standbyState",
"availabilityStates",
"provisionedType",
"actualType",
"holderState"
]
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getCardSlotsUsingGET"
},
"task": true
},
{
"name": "getCardSlotUsingGET",
"summary": "getCardSlotUsingGET",
"description": "Returns detailed information for the specified card slot, which contains a link to the installed card, if not empty. Example: GET /v1/cardSlots/fdn:model:equipment:EquipmentHolder:2127",
"input": [
{
"name": "cardSlotFdn",
"type": "string",
"info": "cardSlotFdn: string",
"required": true,
"schema": {
"title": "cardSlotFdn",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getCardSlotUsingGET"
},
"task": true
},
{
"name": "getCardsUsingGET",
"summary": "getCardsUsingGET",
"description": "Returns a paged list of specific cards. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card. Not providing a filter will return all cards. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card ne...(description truncated)",
"input": [
{
"name": "fdns",
"type": "string",
"info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string",
"required": false,
"schema": {
"title": "fdns",
"type": "string"
}
},
{
"name": "filter",
"type": "string",
"info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string",
"required": false,
"schema": {
"title": "filter",
"type": "string"
}
},
{
"name": "limit",
"type": "number",
"info": "The limit on the number of objects returned (max: 1000): 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "offset",
"type": "number",
"info": "Start row for paged data (max: total number of objects): 123",
"required": false,
"schema": {
"title": "offset",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "array",
"default": "",
"items": {
"title": "Card",
"type": "object",
"properties": {
"links": {
"xml": {
"namespace": "http://www.w3.org/2005/Atom",
"attribute": false,
"wrapped": false
},
"type": "array",
"items": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"xml": {
"name": "href",
"attribute": true,
"wrapped": false
},
"type": "string"
},
"rel": {
"xml": {
"name": "rel",
"attribute": true,
"wrapped": false
},
"type": "string"
},
"templated": {
"type": "boolean"
}
}
}
},
"fdn": {
"description": "The Fully Distinguished Name of this Card.",
"type": "string"
},
"sourceType": {
"type": "object",
"allOf": [
{
"title": "SourceType",
"description": "The type of the source system where this Card is sourced from.",
"example": "nfmp",
"type": "string",
"enum": [
"other",
"nsd",
"nfmp",
"nfmt",
"nrcp",
"nrct",
"nrcf",
"nrcx",
"mdm",
"nsp"
]
},
{
"description": "The type of the source system where this Card is sourced from."
}
]
},
"sourceSystem": {
"description": "The source system where this Card is sourced from.",
"type": "string"
},
"sources": {
"description": "The Fully Distinguished Names of the Cards from the source system associated to this Card.",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "The name of this Card, as defined by the source system.",
"type": "string"
},
"neName": {
"description": "The name of the Network Element containing this Card, as defined by the source system.",
"type": "string"
},
"neId": {
"description": "The id of the Network Element containing this Card, as defined by the source system.",
"type": "string"
},
"description": {
"description": "The detailed description of this Card.",
"type": "string"
},
"positionId": {
"description": "The relative position of the Card, that determines the order in which to show it in the source system UI.",
"type": "integer"
},
"position": {
"description": "A formatted name that describes the position of the Card within the Network Element.",
"type": "string"
},
"adminState": {
"type": "object",
"allOf": [
{
"title": "AdminState",
"description": "The administrative state of this Card. Refer to the X.731 standard.",
"example": "unlocked",
"type": "string",
"enum": [
"unknown",
"unlocked",
"locked",
"forcedLockout",
"shuttingDown",
"maintenance"
]
},
{
"description": "The administrative state of this Card. Refer to the X.731 standard."
}
]
},
"operState": {
"type": "object",
"allOf": [
{
"title": "OperState",
"description": "The operational state of this Card. Refer to the X.731 standard.",
"example": "enabled",
"type": "string",
"enum": [
"unknown",
"enabled",
"disabled"
]
},
{
"description": "The operational state of this Card. Refer to the X.731 standard."
}
]
},
"standbyState": {
"type": "object",
"allOf": [
{
"title": "StandbyState",
"description": "The standby state of this Card. Refer to the X.731 standard.",
"example": "providingService",
"type": "string",
"enum": [
"providingService",
"standby"
]
},
{
"description": "The standby state of this Card. Refer to the X.731 standard."
}
]
},
"availabilityStates": {
"description": "The availability states of this Card. Refer to the X.731 standard.",
"type": "array",
"items": {
"title": "AvailabilityState",
"type": "string",
"enum": [
"unknown",
"inTest",
"failed",
"degraded",
"offLine",
"powerOff",
"offDuty",
"dependency",
"notInstalled",
"logFull"
]
}
},
"stateReasons": {
"description": "A set of specific reasons why the Card is in this state.",
"type": "array",
"items": {
"type": "string"
}
},
"objectDetails": {
"description": "Generic properties of this Card, specific to the Network Supervision application.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"manufacturer": {
"description": "The vendor of the Card.",
"type": "string"
},
"serialNumber": {
"description": "The serial number of the Card provided by the manufacturer.",
"type": "string"
},
"partNumber": {
"description": "The part number of the Card provided by the manufacturer.",
"type": "string"
},
"manufacturerAssemblyNumber": {
"description": "The assembly number of the Card provided by the manufacturer.",
"type": "string"
},
"manufactureDate": {