TAG LINE
SMALL TITLE

Data Import

(API Version v4)


What can you do with DataImport?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the DataImport
ownerId
READ-ONLY
"ownerId": 20
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Hello World"
Type: String
dataProfileId
"dataProfileId": 4
Type: Number
Unique identifier for the associated DataProfile object.
dataProfileName
"dataProfileName": "Sample Name"
Type: String
The name of the object associated with the dataProfileId property.
envelopesPerRequest
"envelopesPerRequest": 13
Type: Number
patchesPerEnvelope
"patchesPerEnvelope": 19
Type: Number
stopOnError
"stopOnError": true
Type: Boolean


End Points

GETapi/v4/DataImport/{id}/LastUpload
Retrieve all of the LastUpload objects for the specified DataImport.
{id}Unique identifier for the DataImport object.
Retrieve all of the LastUpload objects for the specified DataImport.
GET api/v4/DataImport/{id}/LastUpload
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 26,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "dataProfileId": 23,
        "dataProfileName": "Sample Text Data",
        "envelopesPerRequest": 20,
        "patchesPerEnvelope": 2,
        "stopOnError": true
    }
}
POSTapi/v4/DataImport/{id}/LastUploadSearch
Retreive a list of DataImport objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of DataImport objects based on search criteria.
POST api/v4/DataImport/{id}/LastUploadSearch

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 14,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "dataProfileId": 11,
            "dataProfileName": "Sample Text Data",
            "envelopesPerRequest": 2,
            "patchesPerEnvelope": 1,
            "stopOnError": true
        }
    ]
}