Data Extract

Two endpoints are available:

operations

Get the available DataExtract operations endpoints.

GET api/tool/DataExtract/operations/
 ?hierarchy=[hierarchy]
 &format=json

Returned payload:

{"meta":
  {"query":"/api/tool/DataExtract/operations/
            ?hierarchy=[hierarchy]
            &format=json"},
  "choices":[
    {"value":"execute",
     "title":"Execute"},
    {"value":"help",
     "title":"Help"},
    {"value":"nbi_subscriber",
     "title":"Nbi Subscriber"},
    {"value":"read",
    "title":"Read"}]
}

nbisubscriber

For example, on a system with NBI deployed, get the subscriber data for subscriber instance with <PKID>:

GET api/tool/DataExtract/nbisubscriber/<PKID>/
 ?hierarchy=[hierarchy]
 &format=json

Returned payload:

{
 "FirstName": "NBI",
 "LastName": "User EKB-9492",
 "ActivationDate": "2021-06-17T00:00:00",
 "Location": "CL1-AB-C-Berlin",
 "Email": "[email protected]",
 "Username": "NBIUser",
 "ExternalID": "EKB-8003-AB-C-BE",
 "Customer": "AB_Group",
 "Lines": [
 {
  "DDI": "+494215381218",
  "ExtensionNumber": "8211218"
 },
 {
  "DDI": "+494215381227",
  "ExtensionNumber": "8211227"
 }
 ],
 "Devices": [
 {
  "Model": "Microsoft Teams",
  "Name": "[email protected]"
 }
 ],
 "FMC": {},
 "EndUserVoicemail": false,
 "HardwareGroup": "[\"AB_Group-Germany-CL1-NDL\", \"hcs.CS-P.CS-AB.AB_Group\"]",
 "MobilityProfiles": [
 {
  "Model": "Cisco 6921",
  "Name": "NBIUser-UDP"
 }
 ]
}