node-red-contrib-monogoto-customer

swagger: '2.0' info: version: 0.0.1 title: Monogoto API description: A description of Monogoto's API and it's services basePath: / schemes: - https consumes: - application/json produces: - application/json paths: /priceplan/accessible-for-customer/{CustomerId}/: get: description: | Return all price plans tags: - Price Plan operationId: priceplan.getPricePlanForCustomerId parameters: - name: CustomerId in: path description: ID of the Customer required: true type: string - name: limit in: query type: string description: Specifies how many records should be returned - name: offset in: query type: string description: Specifies how many records should be skipped responses: '200': description: Array of price plans schema: $ref: '#/definitions/ArrayOfPricePlans' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not Found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /report-history/downloadReport/csv/{csvPath}: get: tags: - Report History description: > Download the CSV report, by path, which you can received from the report history info operationId: report.downloadReportCSV parameters: - name: csvPath in: path description: The CSV path, found in the report history info required: true type: string responses: '200': description: The CSV contents of the reports '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /things/: x-swagger-router-controller: thing get: tags: - Thing description: | Returns list of things by UI search operationId: thing.getThingsUIApi parameters: - name: id in: query description: query default: things-browser.list type: string - name: filterBy[ThingName] in: query description: Filters things by ThingName type: string - name: filterBy[ThingsGroupName] in: query description: Filters things by ThingsGroupName type: string - name: filterBy[Networks] in: query description: Filters things by NetworkName type: string - name: filterBy[ActiveMobileSubscriber] in: query description: Filters things by ActiveMobileSubscriber IMSI type: string - name: filterBy[Last_DATA_Time] in: query description: Filters things by Last_DATA_Time type: string - name: filterBy[IMEI] in: query description: Filters things by IMEI type: string - name: filterBy[MSISDN] in: query description: Filters things by MSISDN type: string - name: filterBy[CellId] in: query description: Filters things by CellId type: string - name: filterBy[Lac] in: query description: Filters things by Lac type: string - name: filterBy[MnoName] in: query description: Filters things by MnoName type: string - name: filterBy[ExternalUniqueId] in: query description: Filters things by ExternalUniqueId type: string - name: State in: query description: Filters things by State type: string - name: filterBy[ThingDescription] in: query description: Filters things by ThingDescription type: string - name: filterBy[Tags][0] in: query description: Filters things by comma-separated Tag Id's type: string - name: filterBy[Tags][1] in: query description: Filters things by comma-separated Tag Id's type: string - name: filterBy[Tags][2] in: query description: Filters things by comma-separated Tag Id's type: string - name: filterBy[Tags][3] in: query description: Filters things by comma-separated Tag Id's type: string - name: sortBy[ThingName] in: query description: >- sort things by thing name ,please insert DESC (descending) or ASC (ascending). type: string - name: sortBy[ThingsGroupName] in: query description: >- sort things by thing name ,please insert DESC (descending) or ASC (ascending). type: string - name: sortBy[Networks] in: query description: >- sort things by thing Networks ,please insert DESC (descending) or ASC (ascending). type: string - name: sortBy[ActiveMobileSubscriber] in: query description: >- sort things by thing ActiveMobileSubscriber ,please insert DESC (descending) or ASC (ascending). type: string - name: sortBy[Last_DATA_Time] in: query description: sortBy things by Last_DATA_Time type: string - name: sortBy[IMEI] in: query description: >- sort things by thing IMEI ,please insert DESC (descending) or ASC (ascending). type: string - name: sortBy[MSISDN] in: query description: sortBy things by MSISDN type: string - name: sortBy[CellId] in: query description: sortBy things by CellId type: string - name: sortBy[Lac] in: query description: sortBy things by Lac type: string - name: sortBy[MnoName] in: query description: sortBy things by MnoName type: string - name: sortBy[ExternalUniqueId] in: query description: sortBy things by ExternalUniqueId type: string - name: State in: query description: sortBy things by State type: string - name: sortBy[ThingDescription] in: query description: sortBy things by ThingDescription type: string - name: limit in: query description: >- Specifies amount of things to be returned ( default value - 10 , max - 50 ). type: string - name: offset in: query description: Specifies the offset from which things will be returned type: string responses: '200': description: List of Things is returned schema: $ref: '#/definitions/ThingInThingsList' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /Auth: x-swagger-router-controller: auth post: tags: - Auth description: >- Login User by POST UserName and Password parameters. Return JSON with JWT and Role operationId: auth.LoginWebApi parameters: - name: body in: body description: Username and password required: true schema: $ref: '#/definitions/Login' responses: '200': description: Returns JSON with JWT and Role '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /apn/allowedtocustomer: x-swagger-router-controller: apn get: tags: - APN description: Returns all APNs allowed to the customer operationId: apn.getApnAllowedToCustomerWebApi responses: '200': description: Array of APNs schema: $ref: '#/definitions/Apns' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /alert/: x-swagger-router-controller: alert post: tags: - Alerts description: >- Add a new Alert. Alert can be assigned to a provided list of Things Group operationId: alert.addAlert parameters: - name: body in: body description: New alert parameters required: true schema: $ref: '#/definitions/ModifyAlert' responses: '200': description: Newly created Alert ID '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' get: tags: - Alerts description: List of all alerts that are defined for the account operationId: alert.getAlertsByCustomer responses: '200': description: Array of configured Alerts schema: $ref: '#/definitions/Alerts' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /alert/{AlertId}: x-swagger-router-controller: alert put: tags: - Alerts description: Update an Alert operationId: alert.updateAlert parameters: - name: AlertId in: path description: Alert ID required: true type: string - name: body in: body description: Edit alert parameters required: true schema: $ref: '#/definitions/ModifyAlert' responses: '200': description: Updated Alert ID '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' get: tags: - Alerts description: Returns a single Alert operationId: alert.getAlertById parameters: - name: AlertId in: path description: Alert ID required: true type: string responses: '200': description: Alert entity schema: $ref: '#/definitions/Alert' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' delete: tags: - Alerts description: Delete a single alert operationId: alert.deleteAlert parameters: - name: AlertId in: path description: Alert ID required: true type: string responses: '200': description: Alert successfully deleted '400': description: Alert is already deleted schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /alarms/: x-swagger-router-controller: alarm get: tags: - Alarms description: Returns all alarms for the account operationId: alarm.getFiredAlertsForCustomerWebApi responses: '200': description: A list of all alarms schema: $ref: '#/definitions/Alarms' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' delete: tags: - Alarms description: Clears all alarms in the account operationId: alarm.deleteAllCustomeralarmsWebApi responses: '200': description: Alarms successfully deleted '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /alarms/{alarmId}: x-swagger-router-controller: alarm delete: tags: - Alarms description: Delete a single alarm operationId: alarm.deletealarmWebApi parameters: - name: alarmId in: path description: Alarm ID required: true type: string responses: '200': description: Alarm was successfully deleted '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' /ippools/: x-swagger-router-controller: ippools get: tags: - IP Pools description: Returns IP Pools owned by the account operationId: ippool.get responses: '200': description: Array of IP Pools schema: $ref: '#/definitions/IPPools' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /ippools/{IPPoolId}: x-swagger-router-controller: ippools get: tags: - IP Pools description: Returns IP Pool according to IPPoolId operationId: ippool.getIPPool parameters: - name: IPPoolId in: path description: IP Pool ID required: true type: string responses: '200': description: IP Pool schema: $ref: '#/definitions/IPPool' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /ippools/findPool: x-swagger-router-controller: ippools post: tags: - IP Pools description: >- Find best matching pool allocated to given customer according to IPv type, public/private and size. Choose smallest available pool that has size >= WantedPoolSize. If that pool's size is double or more of WantedPoolSize, greedily divide that pool into smaller pools, returning a pool that is as close as possible to WantedPoolSize. Make sure that this pool is not the customer's public address operationId: ippools.findPool parameters: - name: body in: body description: Find pool parameters required: true schema: $ref: '#/definitions/findPool' responses: '200': description: IP Pool structure schema: $ref: '#/definitions/IPPool' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /ippools/allocatePoolToNetwork/{IPPoolId}/{NetworkId}/: x-swagger-router-controller: ippools get: tags: - IP Pools description: >- Mark IP pool (identified by IPPool ID) as allocated to network (identified by Network ID) operationId: ippool.allocatePoolToNetwork parameters: - name: IPPoolId in: path description: IP Pool ID required: true type: string - name: NetworkId in: path description: Network ID required: true type: string responses: '200': description: Success message '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /ippools/freePool/{IPPoolId}: x-swagger-router-controller: ippools get: tags: - IP Pools description: >- Mark IP pool (identified by IPPool ID) as no longer allocated to any network. Pool still belongs to the customer operationId: ippool.freePool parameters: - name: IPPoolId in: path description: IP Pool ID required: true type: string responses: '200': description: Success message '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' /ippools/subnet/{IPPoolId}: x-swagger-router-controller: ippools post: tags: - IP Pools description: API endpoint to divide Network by several subnets operationId: ippool.subnetIpool parameters: - name: IPPoolId in: path description: IP Pool ID required: true type: string - name: body in: body description: Subnet parameters required: true schema: $ref: '#/definitions/subnetIPPool' responses: '200': description: Subnet operation succeed '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' /ippools/freePoolFromNetwork/{IPPoolId}: x-swagger-router-controller: ippools get: tags: - IP Pools description: Free pool from network operationId: ippool.freePoolFromNetwork parameters: - name: IPPoolId in: path description: IP Pool ID required: true type: string responses: '200': description: Delete IPs of Pool completed '400': description: The key does not exist on the server schema: $ref: '#/definitions/ErrorResponse' /network: x-swagger-router-controller: network post: tags: - NETWORK description: Create a new Network operationId: network.create parameters: - name: body in: body description: New Network object required: true schema: $ref: '#/definitions/UpdateNetwork' responses: '200': description: Network created '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - NETWORK description: Returns all networks of this account operationId: network.get responses: '200': description: Array of Networks schema: $ref: '#/definitions/Networks' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/inBulk: delete: tags: - NETWORK description: Delete Networks in bulk operationId: network.deleteNetworksInBulkWebApi parameters: - name: Networks in: body description: Array of Network Ids required: true schema: type: array items: type: string responses: '200': description: Networks were deleted successfully '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/{NetworkId}: x-swagger-router-controller: network put: tags: - NETWORK description: Edit existing network operationId: network.update parameters: - name: NetworkId in: path description: Network ID required: true type: string - name: body in: body description: Edit network parameters required: true schema: $ref: '#/definitions/UpdateNetwork' responses: '200': description: Network successfully updated '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - NETWORK description: Returns single Network according to given Network ID operationId: network.getsingle parameters: - name: NetworkId in: path description: Network ID required: true type: string responses: '200': description: Network object schema: $ref: '#/definitions/Network' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' delete: tags: - NETWORK description: Delete Network by given Network Id operationId: network.delete parameters: - name: NetworkId in: path description: Network ID required: true type: string responses: '200': description: Network successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/vpnStatus/{NetworkId}: x-swagger-router-controller: network get: tags: - NETWORK description: Returns the Network VPNs status according to given Network ID operationId: network.getVpnsStatusWebApi parameters: - name: NetworkId in: path description: Network ID required: true type: string responses: '200': description: Network VPNs status schema: $ref: '#/definitions/VpnsStatus' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/vpnRefresh/{NetworkId}/{VPNName}: x-swagger-router-controller: network get: tags: - NETWORK description: Refresh Network VPN operationId: network.refreshVpnWebApi parameters: - name: NetworkId in: path description: Network ID required: true type: string - name: VPNName in: path description: VPN Name required: true type: string responses: '200': description: Successfully refresh VPN '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/PingVpnGW/{NetworkId}/{VPNName}: x-swagger-router-controller: network get: tags: - NETWORK description: Ping VPN GW operationId: network.pingVpnGWWebApi parameters: - name: NetworkId in: path description: Network ID required: true type: string - name: VPNName in: path description: VPN Name required: true type: string responses: '200': description: Ping Result '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /network/PingVpnClient/{NetworkId}/{VPNName}/{IP}: x-swagger-router-controller: network get: tags: - NETWORK description: Ping VPN Client IP operationId: network.pingVpnClientWebApi parameters: - name: NetworkId in: path description: Network ID required: true type: string - name: VPNName in: path description: VPN Name required: true type: string - name: IP in: path description: VPN Client IP required: true type: string responses: '200': description: Ping Result '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /tags: x-swagger-router-controller: tags get: tags: - Tagging description: Returns all tags operationId: tags.getAllTags parameters: - name: TagNamePrefix in: query type: string description: Specifies prefix tag name should start with responses: '200': description: Tags entities schema: $ref: '#/definitions/Tags' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' post: tags: - Tagging description: Creates tag operationId: tags.createTag parameters: - name: body in: body description: Tag entity schema: $ref: '#/definitions/TagCreate' responses: '200': description: Tag successfully created schema: $ref: '#/definitions/TagId' '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '403': description: You are not allowed to create tag with realm Operator schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /tags/bulk: delete: tags: - Tagging description: Bulk delete tags operationId: tags.bulkDeleteTags parameters: - name: body in: body description: Array of tag Id's schema: $ref: '#/definitions/TagIds' responses: '200': description: Tags successfully deleted '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /tags/{TagId}: x-swagger-router-controller: tags get: tags: - Tagging description: Get tag by Tag Id operationId: tags.getTag parameters: - name: TagId in: path required: true type: string description: Tag Id responses: '200': description: Tag entity schema: $ref: '#/definitions/Tag' '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' put: tags: - Tagging description: Update tag by Tag Id operationId: tags.updateTag parameters: - name: TagId in: path required: true type: string description: Update tag by Tag Id - name: body in: body description: Tag entity schema: $ref: '#/definitions/Tag' responses: '200': description: Tag successfully updated '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' delete: tags: - Tagging description: Delete tag by Tag Id operationId: tags.deleteTag parameters: - name: TagId in: path required: true type: string description: Tag Id responses: '200': description: Tag successfully updated '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /tags/apply: x-swagger-router-controller: tags post: tags: - Tagging description: Apply tags to things operationId: tags.applyTags parameters: - name: body in: body description: >- Body contains 'filterBy' parameters which are used to apply tags to things. Parameters of 'filterBy' field are not mandatory. When used - things are filtered out by provided values. ThingId in 'filterBy' is optional as well, thus tags will be applied to all things. schema: $ref: '#/definitions/TagsApply' responses: '200': description: Tags are pending to be applied '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /tags/unapply: x-swagger-router-controller: tags post: tags: - Tagging description: Unapply tags from things operationId: tags.unapplyTags parameters: - name: body in: body description: >- Body contains 'filterBy' parameters which are used to unapply tags from things. Parameters of 'filterBy' are is not mandatory. When used - things are filtered out by provided values. ThingId in 'filterBy' is optional as well, thus tags will be unapplied from all things. schema: $ref: '#/definitions/TagsUnapply' responses: '200': description: Tags are pending to be unapplied '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': null description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /telephonyprofile/: x-swagger-router-controller: telephonyprofile post: tags: - Telephony Profile description: Create a new telephony profiles operationId: telephonyprofile parameters: - name: body in: body description: Telephony profile required: true schema: $ref: '#/definitions/UpdateTelephonyProfile' responses: '200': description: Telephony profile created - returns ID '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - Telephony Profile description: Return the all the telephony profiles for this account operationId: telephonyprofile.get responses: '200': description: JSON of Telephony Profiles schema: $ref: '#/definitions/TelephonyProfiles' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /telephonyprofile/{TelephonyProfileId}: x-swagger-router-controller: telephonyprofile put: tags: - Telephony Profile description: Update a telephony profile operationId: telephonyprofile.update parameters: - name: TelephonyProfileId in: path description: Telephony Profile ID required: true type: string - name: body in: body description: Update Telephony profile parameters required: true schema: $ref: '#/definitions/UpdateTelephonyProfile' responses: '200': description: Telephony profile updated '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' delete: tags: - Telephony Profile description: Delete Telephony Profiles operationId: telephonyprofile.delete parameters: - name: TelephonyProfileId in: path description: Telephony Profile ID required: true type: string responses: '200': description: Telephony profile successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - Telephony Profile description: Return specific Telephony Profiles by Telephony Profile ID operationId: telephonyprofile.getsingle parameters: - name: TelephonyProfileId in: path description: Telephony Profile ID required: true type: string responses: '200': description: Telephony profile successfully deleted schema: $ref: '#/definitions/TelephonyProfile' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /telephonyprofile/bulk: delete: tags: - Telephony Profile description: Delete telephony profiles according to given Telephony Profiles Ids operationId: telephonyprofile.deleteInBulkWebApi parameters: - name: body in: body description: delete telephony profiles parameters required: true schema: $ref: '#/definitions/TelephonyProfilesIds' responses: '200': description: Telephony profiles successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /telephonyprofile/deleteAll: delete: tags: - Telephony Profile description: Delete all telephony profiles from the account operationId: telephonyprofile.deleteAllCustomerTelephonyProfilesWebApi responses: '200': description: Telephony profiles successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /ipprofile/: x-swagger-router-controller: ipprofile post: tags: - IP Profile description: Create a new ip profiles operationId: ipprofile parameters: - name: body in: body description: IP profile required: true schema: $ref: '#/definitions/UpdateIPProfile' responses: '200': description: IP profile created - returns ID '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - IP Profile description: Return the all the IP profiles for this account operationId: ipprofile.get responses: '200': description: JSON of IP Profiles schema: $ref: '#/definitions/IPProfiles' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /ipprofile/{IPProfileId}: x-swagger-router-controller: ipprofile put: tags: - IP Profile description: Update a IP profile operationId: ipprofile.update parameters: - name: IPProfileId in: path description: IP Profile ID required: true type: string - name: body in: body description: Update IP profile parameters required: true schema: $ref: '#/definitions/UpdateIPProfile' responses: '200': description: IP profile updated '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' delete: tags: - IP Profile description: Delete IP Profiles operationId: ipprofile.delete parameters: - name: IPProfileId in: path description: IP Profile ID required: true type: string responses: '200': description: IP profile successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' get: tags: - IP Profile description: Return specific IP Profiles by IP Profile ID operationId: ipprofile.getsingle parameters: - name: IPProfileId in: path description: IP Profile ID required: true type: string responses: '200': description: Single ID entity schema: $ref: '#/definitions/IPProfile' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /ipprofile/bulk: delete: tags: - IP Profile description: Delete IP profiles according to given IP Profiles Ids operationId: ipprofile.deleteInBulkWebApi parameters: - name: body in: body description: delete IP profiles parameters required: true schema: $ref: '#/definitions/IPProfilesIds' responses: '200': description: IP profiles successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /ipprofile/deleteAll: delete: tags: - IP Profile description: Delete all ip profiles from the account operationId: ipprofile.deleteAllCustomerIPProfilesWebApi responses: '200': description: IP profiles successfully deleted '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /thing/{ThingId}/: x-swagger-router-controller: thing get: tags: - Thing description: Returns a single Thing operationId: thing.getThingByIdWebApi parameters: - name: ThingId in: path description: Thing ID required: true type: string responses: '200': description: Thing object identified by the Thing ID parameters schema: $ref: '#/definitions/Thing' '401': description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' '404': description: Not found schema: $ref: '#/definitions/ErrorResponse' '500': description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' /thing/status: x-swagger-router-controller: thing get: tags: - Thing description: >- The API returns the thing connection statuses and information regarding active PDP sessions operationId: thing.getThingsStatusesWebApi parameters: - name: ProvisionStatus in: query description: >- Filter by Thing state. Allowed values: PROVISIONED, ACTIVE, SUSPENDED, RETIRED. Case-sensitive. required: false type: string - name: ConnectionStatus in: query description: >- Filter by ConnectionStatus of the thing. Allowed values: DISCONNECTED, CONNECTED. CONNECTED means a thing has an active PDP session. Case-sensitive. required: false type: string - name: ThingIds in: query description: >- Array of thing ids to filter by. Maximum allowed to filter by 50 things. In case it is given, CustomerId, ConnectionStatus and ProvisionStatus filters will not be taken into account required: false type: array items: type: string - name: limit in: query description: Used for pagination. Default limit is 50. Maximum limit is 1000. required: false type: number default: 50 - name: offset in: query description: Used for pagination. Default offset is 0. required: false type: number default: 0 responses: '200': description: Successfully fetched array of things statuses schema: $ref: '#/definitions/ThingsStatuses' '400': description: Invalid Input Data schema: $ref: '#/definitions/ErrorResponse'