TAG LINE
TAG LINE
SMALL TITLE
A Share Plan assigned to an Account. A Share Plan is a way of pooling usage across multiple Services and Packages. This entity is essentially a linking object between a defined Share Plan and an Account.
identity READ-ONLY | "identity": 15 Type: Number This is the unique numeric identifier for the DataExportHistory |
dataExportId READ-ONLY | "dataExportId": 19 Type: Number Unique identifier for the associated DataExport object. |
dataExportName | "dataExportName": "Sample Name" Type: String The name of the object associated with the dataExportId property. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
start | "start": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
complete | "complete": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
dataExportHistoryStatusTypeId | "dataExportHistoryStatusTypeId": 16 Type: Number Unique identifier for the associated DataExportHistoryStatusType object. |
dataExportHistoryStatusTypeName | "dataExportHistoryStatusTypeName": "Sample Name" Type: String The name of the object associated with the dataExportHistoryStatusTypeId property. |
storageLocationId | "storageLocationId": 20 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. |
storageKey | "storageKey": "123ABC" Type: String |
exportRowCount | "exportRowCount": 2 Type: Number Number of rows exported |
createdByUserId | "createdByUserId": 3 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
parameters | "parameters": "Hello World" Type: String |
transferLocationId | "transferLocationId": 8 Type: Number Unique identifier for the associated TransferLocation object. |
transferLocationName | "transferLocationName": "Sample Name" Type: String The name of the object associated with the transferLocationId property. |
fileMoveLogIdentity READ-ONLY | "fileMoveLogIdentity": 16 Type: Number |
| GET | DataExport/History/ |
| Retrieve all of the DataExportHistory objects. | |
Retrieve all of the DataExportHistory objects. GET DataExport/History/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"dataExportId": 22,
"dataExportName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 25,
"dataExportHistoryStatusTypeName": "Sample Text Data",
"storageLocationId": 20,
"storageLocationName": "Sample Text Data",
"storageKey": "123ABC",
"exportRowCount": 26,
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"parameters": "Sample Text Data",
"transferLocationId": 5,
"transferLocationName": "Sample Text Data",
"fileMoveLogIdentity": 23
}
]
} | |
| GET | DataExport/History/Paged |
| Retrieve all of the DataExportHistory 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 DataExportHistory objects in a paged fashion. GET DataExport/History/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,
"dataExportId": 7,
"dataExportName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 24,
"dataExportHistoryStatusTypeName": "Sample Text Data",
"storageLocationId": 14,
"storageLocationName": "Sample Text Data",
"storageKey": "123ABC",
"exportRowCount": 25,
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"parameters": "Sample Text Data",
"transferLocationId": 8,
"transferLocationName": "Sample Text Data",
"fileMoveLogIdentity": 0
}
]
}
} | |
| GET | DataExport/History/{id} |
| Retrieve an instance of the DataExportHistory object by its ID. | |
| {id} | Unique identifier for the DataExportHistory object. |
Retrieve an instance of the DataExportHistory object by its ID. GET DataExport/History/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"dataExportId": 16,
"dataExportName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 2,
"dataExportHistoryStatusTypeName": "Sample Text Data",
"storageLocationId": 14,
"storageLocationName": "Sample Text Data",
"storageKey": "123ABC",
"exportRowCount": 10,
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"parameters": "Sample Text Data",
"transferLocationId": 27,
"transferLocationName": "Sample Text Data",
"fileMoveLogIdentity": 0
}
} | |
| GET | DataExport/History/{id}/Download |
| Returns data for the data export history as a link to a CSV for download. Takes a dataExportHistoryID representing a specific generated export file and returns data for the file from the DataExportHistory table, including the AWS S3 location. DataExport/Trigger returns the DataExportHistoryID so that should be used when fetching the download. The user (API or integration) can then use the returned S3 link to download the file and save it in the required location. NOTE: This is URL to download the file direct from AWS S3. The link will expire after 30 seconds | |
| {id} | Unique identifier for the DataExportHistory object. |
Returns data for the data export history as a link to a CSV for download. GET DataExport/History/{id}/DownloadHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"dataExportId": 10,
"dataExportName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 3,
"dataExportHistoryStatusTypeName": "Sample Text Data",
"storageLocationId": 18,
"storageLocationName": "Sample Text Data",
"storageKey": "Sample Text Data",
"exportRowCount": 21,
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"parameters": "Sample Text Data",
"transferLocationId": 27,
"transferLocationName": "Sample Text Data",
"fileMoveLogIdentity": 27,
"link": "https://foo.com/myfile.csv"
}
} | |
| POST | DataExport/History/{id}/Cancel |
| Create a new instance of a Cancel object that belongs to the DataExportHistory. | |
| {id} | Unique identifier for the DataExportHistory object. |
Create a new instance of a Cancel object that belongs to the DataExportHistory. POST DataExport/History/{id}/Cancel
{
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 3,
"storageLocationId": 25,
"storageKey": "123ABC",
"exportRowCount": 0,
"createdByUserId": 18,
"parameters": "Sample Text Data",
"transferLocationId": 2
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"dataExportId": 6,
"dataExportName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"dataExportHistoryStatusTypeId": 14,
"dataExportHistoryStatusTypeName": "Sample Text Data",
"storageLocationId": 6,
"storageLocationName": "Sample Text Data",
"storageKey": "123ABC",
"exportRowCount": 10,
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"parameters": "Sample Text Data",
"transferLocationId": 11,
"transferLocationName": "Sample Text Data",
"fileMoveLogIdentity": 20
}
]
}
} | |