TAG LINE
TAG LINE
SMALL TITLE
Import raw usage data for the specified usage feed to get meditated and rated. The API sends the data asynchronously to the file importer for processing and responds with a tracking identifier for traceability.
| GET | DataImport/Usage/Download |
| Retrieve all of the DataImportUsage objects. | |
Retrieve all of the DataImportUsage objects. GET DataImport/Usage/Download HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| GET | DataImport/Usage/Feed/{id} |
| Retrieve an instance of the DataImportUsage object by its ID. | |
| {id} | Unique identifier for the DataImportUsage object. |
Retrieve an instance of the DataImportUsage object by its ID. GET DataImport/Usage/Feed/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {}
} | |
| GET | DataImport/Usage/Feed/{name} |
| Retrieve all of the DataImportUsage objects. | |
Retrieve all of the DataImportUsage objects. GET DataImport/Usage/Feed/{name}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| GET | DataImport/Usage/History |
| Retrieve all of the DataImportUsage objects. | |
Retrieve all of the DataImportUsage objects. GET DataImport/Usage/History HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| GET | DataImport/Usage/History/{id} |
| Retrieve an instance of the DataImportUsage object by its ID. | |
| {id} | Unique identifier for the DataImportUsage object. |
Retrieve an instance of the DataImportUsage object by its ID. GET DataImport/Usage/History/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {}
} | |
| GET | DataImport/Usage/History/{id}/Detail |
| Retrieve deep detail of the DataImportUsage object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the DataImportUsage object. |
Retrieve deep detail of the DataImportUsage object by its ID. GET DataImport/Usage/History/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| GET | DataImport/Usage/Tracking/{trackingId} |
| Retrieve all of the DataImportUsage objects. | |
Retrieve all of the DataImportUsage objects. GET DataImport/Usage/Tracking/{trackingId}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| GET | DataImport/Usage/Tracking/{trackingId}/Detail |
| Retrieve all of the DataImportUsage objects. | |
Retrieve all of the DataImportUsage objects. GET DataImport/Usage/Tracking/{trackingId}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| POST | DataImport/Usage/History/{id}/Reprocess |
| Create a new instance of a Reprocess object that belongs to the DataImportUsage. | |
| {id} | Unique identifier for the DataImportUsage object. |
Create a new instance of a Reprocess object that belongs to the DataImportUsage. POST DataImport/Usage/History/{id}/Reprocess
{}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{}
]
}
} | |
| POST | DataImport/Usage/Json/Multi/{id} |
| Insert multiple raw data usage records in a JSON format for a Usage Feed specified by {id}. | |
| {id} | Unique identifier for the Usage Feed to which this payload should be applied. |
Insert multiple raw data usage records in a JSON format for a Usage Feed specified by {id}. POST DataImport/Usage/Json/Multi/{id}
{
"data": [
{
"DateTime": "2023-04-25T01:01:00.06",
"UdrIdentifierTypeName": "Unknown",
"OriginatingIdentifier": "4038675310",
"TerminatingIdentifier": "4038675346",
"UdrUsageIdentifier": "814-241-4332",
"Value": 134,
"Inbound": false,
"ReverseRating": false,
"UsageClassName": "data_class",
"UsageClassTypeName": "data_classType"
},
{
"DateTime": "2023-04-26T01:01:00.07",
"UdrIdentifierTypeName": "Unknown",
"OriginatingIdentifier": "4038675311",
"TerminatingIdentifier": "4038675347",
"UdrUsageIdentifier": "814-241-4332",
"Value": 135,
"Inbound": false,
"ReverseRating": false,
"UsageClassName": "data_class",
"UsageClassTypeName": "data_classType"
}
]
}HTTP/1.1 200 OK
{
"trackingId": "78578940-e75f-4984-9db3-75fdf552913d",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"action": "created",
"dtoTypeKey": "dataImportRequestTracking",
"instance": {
"trackingId": "a654294f-9fd6-4576-aeec-b4531b742dd1",
"udrFeedId": 3
}
}
]
}
} | |
| POST | DataImport/Usage/Json/{id} |
| Insert single raw data usage record in a JSON format for a Usage Feed specified by {id} | |
| {id} | Unique identifier for the Usage Feed to which this payload should be applied. |
Insert single raw data usage record in a JSON format for a Usage Feed specified by {id} POST DataImport/Usage/Json/{id}
{
"DateTime": "2023-04-25T01:01:00.06",
"UdrIdentifierTypeName": "Unknown",
"OriginatingIdentifier": "555xtgr8675310",
"TerminatingIdentifier": "403dsf867sfsd5346",
"UdrUsageIdentifier": "ssty814-24ss1-433d2",
"Value": 134,
"Inbound": false,
"ReverseRating": false,
"UsageClassName": "data_class",
"UsageClassTypeName": "data_classType"
}HTTP/1.1 200 OK
{
"trackingId": "b4701009-121f-4903-a33d-c0039b33a512",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"action": "created",
"dtoTypeKey": "dataImportRequestTracking",
"instance": {
"trackingId": "0e6042bb-ccbe-41d9-b471-69c988c990ab",
"udrFeedId": 3
}
}
]
}
} | |
| POST | DataImport/Usage/{apifeedname} |
| Create a new instance of the DataImportUsage object. | |
Create a new instance of the DataImportUsage object. POST DataImport/Usage/{apifeedname}
{}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{}
]
}
} | |
| POST | DataImport/Usage/{id} |
| Insert raw data usage record with payload that matches the requirements of Usage Feed specified by {id} | |
| {id} | Unique identifier for the Usage Feed to which this payload should be applied. |
Insert raw data usage record with payload that matches the requirements of Usage Feed specified by {id} POST DataImport/Usage/{id}
{
"data": [
"106ab566-c0fd-46ed-8932-4365208cd0e3",
"106ab566-c0fd-46ed-8932-4365208cd0e3",
"106ab566-c0fd-46ed-8932-4365208cd0e3"
]
}HTTP/1.1 200 OK
{
"trackingId": "43fa3978-c1cc-4a48-afaa-5e1f9955d5ab",
"type": "sendMessage",
"results": {
"totalCount": 1,
"items": [
{
"action": "messageSent",
"dtoTypeKey": "dataImportUsageResults",
"instance": {
"identity": 100,
"successful": true
}
}
]
}
} | |