Skip to content

Latest commit

 

History

History
282 lines (208 loc) · 10.1 KB

CustomerDataApi.md

File metadata and controls

282 lines (208 loc) · 10.1 KB
Raw

pxcloud_api_client.CustomerDataApi

All URIs are relative to https://api-cx.cisco.com/px

Method HTTP request Description
lifecycle GET /v1/customers/{customerId}/lifecycle Get customer lifecycle
report_summary GET /v1/customers/{customerId}/reports/{reportId} Get the report
reports POST /v1/customers/{customerId}/reports Request customer data reports as bulk files

lifecycle

RacetrackBuid lifecycle(success_track_id, customer_id)

Get customer lifecycle

Get customer lifecycle which will provide the CX solution, use case and pitstop information for the customer

Example

  • OAuth Authentication (oAuth2):
import time
import pxcloud_api_client
from pxcloud_api_client.api import customer_data_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.racetrack_buid import RacetrackBuid
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = customer_data_api.CustomerDataApi(api_client)
    success_track_id = "successTrackId_example" # str | 
    customer_id = "customerId_example" # str | Unique identifier for the Customer

    # example passing only required values which don't have defaults set
    try:
        # Get customer lifecycle
        api_response = api_instance.lifecycle(success_track_id, customer_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling CustomerDataApi->lifecycle: %s\n" % e)

Parameters

Name Type Description Notes
success_track_id str
customer_id str Unique identifier for the Customer

Return type

RacetrackBuid

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation * Date -
400 Bad Request * Date -
403 Forbidden * Date -
404 Not Found * Date -
500 Internal server error * Date -
503 Service Unavailable * Date -
504 Gateway timeout * Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

report_summary

[ReportStatus] report_summary(report_id, customer_id)

Get the report

Provides the status of resource. The status API provides additional info about the progress of the report. Partner application should poll periodically to get status of the report. When the report is complete the API responds with the 303 status pointing to final report in the Location header.

Example

  • OAuth Authentication (oAuth2):
import time
import pxcloud_api_client
from pxcloud_api_client.api import customer_data_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.report_status import ReportStatus
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = customer_data_api.CustomerDataApi(api_client)
    report_id = "reportId_example" # str | Report id
    customer_id = "customerId_example" # str | Unique identifier for the Customer

    # example passing only required values which don't have defaults set
    try:
        # Get the report
        api_response = api_instance.report_summary(report_id, customer_id)
        pprint(api_response)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling CustomerDataApi->report_summary: %s\n" % e)

Parameters

Name Type Description Notes
report_id str Report id
customer_id str Unique identifier for the Customer

Return type

[ReportStatus]

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Provides the status of the report * Date -
303 Provides the final report resource to download the file * Date -
* Location - downloadable URL
400 Bad Request * Date -
403 Forbidden * Date -
404 Not Found * Date -
500 Internal server error * Date -
503 Service Unavailable * Date -
504 Gateway timeout * Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reports

reports(customer_id)

Request customer data reports as bulk files

Request customer data report. Creating a request for customer data sets like Assets, Hardware, Software and Advisories bulk json files

Example

  • OAuth Authentication (oAuth2):
import time
import pxcloud_api_client
from pxcloud_api_client.api import customer_data_api
from pxcloud_api_client.model.error_response import ErrorResponse
from pxcloud_api_client.model.report import Report
from pprint import pprint
# Defining the host is optional and defaults to https://api-cx.cisco.com/px
# See configuration.py for a list of all supported configuration parameters.
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: oAuth2
configuration = pxcloud_api_client.Configuration(
    host = "https://api-cx.cisco.com/px"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pxcloud_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = customer_data_api.CustomerDataApi(api_client)
    customer_id = "customerId_example" # str | Unique identifier for the Customer
    report = Report(
        report_name="Assets",
    ) # Report | report infromation (optional)

    # example passing only required values which don't have defaults set
    try:
        # Request customer data reports as bulk files
        api_instance.reports(customer_id)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling CustomerDataApi->reports: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Request customer data reports as bulk files
        api_instance.reports(customer_id, report=report)
    except pxcloud_api_client.ApiException as e:
        print("Exception when calling CustomerDataApi->reports: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str Unique identifier for the Customer
report Report report infromation [optional]

Return type

void (empty response body)

Authorization

oAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted * Location - downloadable URL
* Date -
400 Bad Request * Location - downloadable URL
* Date -
403 Forbidden * Location - downloadable URL
* Date -
404 Not Found * Location - downloadable URL
* Date -
500 Internal server error * Location - downloadable URL
* Date -
503 Service Unavailable * Location - downloadable URL
* Date -
504 Gateway timeout * Location - downloadable URL
* Date -

[Back to top] [Back to API list] [Back to Model list] [Back to README]