TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 18 Type: Number This is the unique numeric identifier for the DataExport |
name | "name": "Hello World" Type: String |
isActive | "isActive": true Type: Boolean |
storageLocationId | "storageLocationId": 6 Type: Number Unique identifier for the associated StorageLocation object. |
storageLocationName | "storageLocationName": "Sample Name" Type: String The name of the object associated with the storageLocationId property. |
dataExportTypeId | "dataExportTypeId": 6 Type: Number Unique identifier for the associated DataExportType object. |
dataExportTypeName | "dataExportTypeName": "Sample Name" Type: String The name of the object associated with the dataExportTypeId property. |
config | "config": "Hello World" Type: String |
| GET | DataExport/ |
| Retrieve all of the DataExport objects. | |
Retrieve all of the DataExport objects. GET DataExport/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"isActive": true,
"storageLocationId": 20,
"storageLocationName": "Sample Text Data",
"dataExportTypeId": 21,
"dataExportTypeName": "Sample Text Data",
"config": "Sample Text Data"
}
]
} | |
| GET | DataExport/Paged |
| Retrieve all of the DataExport objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the DataExport objects in a paged fashion. GET DataExport/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"isActive": true,
"storageLocationId": 25,
"storageLocationName": "Sample Text Data",
"dataExportTypeId": 0,
"dataExportTypeName": "Sample Text Data",
"config": "Sample Text Data"
}
]
}
} | |
| GET | DataExport/{id} |
| Retrieve an instance of the DataExport object by its ID. | |
| {id} | Unique identifier for the DataExport object. |
Retrieve an instance of the DataExport object by its ID. GET DataExport/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"isActive": true,
"storageLocationId": 9,
"storageLocationName": "Sample Text Data",
"dataExportTypeId": 12,
"dataExportTypeName": "Sample Text Data",
"config": "Sample Text Data"
}
} | |
| POST | DataExport/{id}/TriggerExport |
| Create a new instance of a TriggerExport object that belongs to the DataExport. | |
| {id} | Unique identifier for the DataExport object. |
Create a new instance of a TriggerExport object that belongs to the DataExport. POST DataExport/{id}/TriggerExport
{
"name": "Sample Text Data",
"isActive": true,
"storageLocationId": 9,
"dataExportTypeId": 5,
"config": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"isActive": true,
"storageLocationId": 0,
"storageLocationName": "Sample Text Data",
"dataExportTypeId": 2,
"dataExportTypeName": "Sample Text Data",
"config": "Sample Text Data"
}
]
}
} | |