Operation

get /nbi-notification/api/v1/notifications/subscriptions
checkSubscriptionDeletion (checkSubscriptionDeletion : /nbi-notification/api/v1/notifications/subscriptions)
Check Subscription deletion status by specifying the subscription Id.

Path parameters

Name

IsRequired

Description

Enum

authorization required Bearer {{token}} ---

Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: 135.250.203.134:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: c3edc74c-d1f7-4a96-99cd-b2af89714e90

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "clientId": null, "topicId": "ns-eg-09ec28a9-eb05-451d-aa37-3e4c13c889e0", "timeOfSubscription": 1553259451623, "expiresAt": 1553263420414, "stage": "STOPPED", "persisted": true }, "errors": null } }

    External Docs
    See Also :

    Operation

    post /nbi-notification/api/v1/notifications/subscriptions
    createSubscription (createSubscription : /nbi-notification/api/v1/notifications/subscriptions)
    Create subscription by using the Bearer Token that was returned when the API client was authorised via the NSP Authentication and subscribe to the category (Ex: NSP-FAULT, NSP-EQUIPMENT.,) to receive fault management events and equipment events and set property filter.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    authorization required Bearer {{token}} ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    name required Category String ---
    propertyFilter required string in which attribute-value pairs are specified String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    DELETE /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: 135.250.203.134:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 81178a82-7852-4f27-9287-e8c7b6f5174f {}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "d96a95a9-7ba3-4ed5-a202-068413c25c5c", "clientId": null, "topicId": "ns-eg-d96a95a9-7ba3-4ed5-a202-068413c25c5c", "timeOfSubscription": 1553257279931, "expiresAt": 1553260879932, "stage": "ACTIVE", "persisted": true }, "errors": null } }

    External Docs
    See Also :

    Operation

    delete /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}
    deleteSubscription (deleteSubscription : /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId})
    Delete the subscription by specifying the subscription Id.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    authorization required Bearer {{token}} ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    {} required String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    DELETE /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: 135.250.203.134:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 81178a82-7852-4f27-9287-e8c7b6f5174f {}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "errors": [] } }

    External Docs
    See Also :

    Operation

    get /rest-gateway/rest/api/v1/location/services/notifications
    getKafkaNotification (getKafkaNotification : /rest-gateway/rest/api/v1/location/services/notifications)
    Get notification service effective base URL and other information for this service.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /rest-gateway/rest/api/v1/location/services/notifications HTTP/1.1 Host: 135.250.203.134 cache-control: no-cache Postman-Token: 380efccf-039e-4b1a-91e9-32457aa4be48

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "services": [ { "serviceName": "notifications", "instances": [ { "version": "v1", "docUrl": "https://135.250.203.134:8544/nbi-notification/api-docs#!/notifications", "effectiveBaseUrl": "https://135.250.203.134:8544/nbi-notification/api", "endpoints": [ "[GET] /v1/notifications/deletions/{taskId}", "[GET] /v1/notifications/subscriptions", "[POST] /v1/notifications/subscriptions", "[GET] /v1/notifications/subscriptions/{subscriptionId}", "[DELETE] /v1/notifications/subscriptions/{subscriptionId}", "[POST] /v1/notifications/subscriptions/{subscriptionId}/renewals" ] } ] } ] }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /rest-gateway/rest/api/v1/location/services
    getLocationServices (getLocationServices : /rest-gateway/rest/api/v1/location/services)
    When the NSP modules are installed, they are registered with the NSP's nspOS, which consists of a set of platform services used by all NSP modules.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /rest-gateway/rest/api/v1/location/services HTTP/1.1 Host: 135.121.158.143 data ""

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "services": [ { "serviceName": "samo_spanrules", "instances": [ { "version": "v2", "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95spanrules", "effectiveBaseUrl": "https://135.121.158.143:8443/nfm-p/rest/api", "endpoints": [ "[POST] /v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUserGroups/{instanceFullName}", "[POST] /v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUsers/{instanceFullName}" ] } ] }, { "serviceName": "samo_mplstp", "instances": [ { "version": "v2", "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveBaseUrl": "https://135.121.158.143:8443/nfm-p/rest/api", "endpoints": [ "[POST] /v2/mplstp/BFDTemplate/findP2PLsp/{instanceFullName}", "[POST] /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections", "[POST] /v2/mplstp/GlobalTPLsp/createWithAutoFillForIncompleteConnections" ] } ] }, ] }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /rest-gateway/rest/api/v1/location/services/endpoints?endPoint= /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections
    getServiceEndpoint (getServiceEndpoint : /rest-gateway/rest/api/v1/location/services/endpoints?endPoint= /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections)
    This step provides all the REST endpoints that belong to the service specified in serviceName.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    endpoint required /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /rest-gateway/rest/api/v1/location/services/endpoints?endPoint=%20/v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections Host: 135.121.158.143 data ""

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "endpoints": [ { "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveUrl": "https://135.121.157.103:8443/nfm-p/rest/api", "operation": "[POST]" }, { "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveUrl": "https://135.121.156.84:8443/nfm-p/rest/api", "operation": "[POST]" } ] }, "errors": null } }

    External Docs
    See Also :

    Operation

    post /rest-gateway/rest/api/v1/auth/revocation
    getSessionTermination (getSessionTermination : /rest-gateway/rest/api/v1/auth/revocation)
    A bearer token can be terminated by sending a POST request to the rest-gateway endpoint with the token or client User_name details.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    token required Token String ---
    tokenTypeHint required token type String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST POST /rest-gateway/rest/api/v1/auth/revocation HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== data "token={{token}}&token_type_hint=token"

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}
    getSubscription (getSubscription : /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId})
    Get Subscription information for specific subscription ID.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    authorization required Bearer {{token}} ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: 135.250.203.134:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 7692b6eb-6e0c-4878-b26a-9fa2cee7980f

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "clientId": null, "topicId": "ns-eg-09ec28a9-eb05-451d-aa37-3e4c13c889e0", "timeOfSubscription": 1553259451623, "expiresAt": 1553263051624, "stage": "ACTIVE", "persisted": true }, "errors": null } }

    External Docs
    See Also :

    Operation

    post /rest-gateway/rest/api/v1/auth/token
    getToken (getToken : /rest-gateway/rest/api/v1/auth/token)
    Prior to sending any REST requests, the OSS application must first authenticate an existing NSP user. The authentication POST request uses Basic authorization and implements a string in base64 encoding, used to encode the username and password (separated by a colon). i.e username:password.The access_token lasts for 3600 seconds by default which is defined by the expires_in attribute. Once the token expires to continue the communication with NSP, a new token can be requested. Alternatively, prior to that time expiring, send a post request with the “refresh token” which will generate a new Bearer token that is valid for another “expire_in” seconds without needing to resend credentials using basic authentication.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== Cache-Control: no-cache Postman-Token: ea14de89-fba4-7c60-cb9e-f3c87262fce1 { "grant_type": "client_credentials" } For Refresh Token POST /rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== Cache-Control: no-cache Postman-Token: ea14de89-fba4-7c60-cb9e-f3c87262fce1 { "grant_type": "refresh_token", "refresh_token": "{{refresh_token}}" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "access_token": "VEtOLWFkbWluZDNjZjlkYTMtMzgzNi00YmJkLWIxZTctMmYzNjMxYzllNzZl", "refresh_token": "UkVUS04tYWRtaW5mN2U1YTVhZi1hYjNkLTQ0OTktODdjNi02MTNjOGFmYWVmNGQ=", "token_type": "Bearer", "expires_in": 3600 } For Refresh Token { "access_token": "VEtOLWFkbWluZDNjZjlkYTMtMzgzNi00YmJkLWIxZTctMmYzNjMxYzllZDA5", "refresh_token": "UkVUS04tYWRtaW5mN2U1YTVhZi1hYjNkLTQ0OTktODdjNi02MTNjOGFmYWVmNGQ=", "token_type": "Bearer", "expires_in": 3600 }

    External Docs
    See Also :

    Operation

    post /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}/renewals
    renewSubscription (renewSubscription : /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}/renewals)
    Renew Subscription by specifying the subscription Id.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    authorization required Bearer {{token}} ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    {} required String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0/renewals HTTP/1.1 Host: 135.250.203.134:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 73379dc6-5d5e-431f-822e-1f387e080f9b {}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": 1553263420414, "errors": null } }

    External Docs
    See Also :