Data Import

What can you do with DataImport?


Properties

Property Details
id
"id": 10
Type: Number
This is the unique numeric identifier for the DataImport
ownerId
"ownerId": 980
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
dataProfileId
"dataProfileId": 159
Type: Number
Unique identifier for the associated DataProfile object.
envelopesPerRequest
"envelopesPerRequest": 979
Type: Number
patchesPerEnvelope
"patchesPerEnvelope": 23
Type: Number
stopOnError
"stopOnError": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • dataProfileId
  • envelopesPerRequest
  • patchesPerEnvelope
  • stopOnError

DataFlow PATCH objects:


End Points

DELETEapi/v1/DataImport/{id:int}
Delete an instance of the DataImport object.
GETapi/v1/DataImport
Retrieve all of the DataImport objects.
GETapi/v1/DataImport/Metadata
Retrieve all of the meta data details of the DataImport object.
GETapi/v1/DataImport/Metadata/{option}
Retrieve all the meta data details of the DataImport object based on provided options.
{option}Metadata options for the DataImport object.
GETapi/v1/DataImport/Paged
Retreive all of the DataImport objects in a paged fashion.
GETapi/v1/DataImport/{id:int}
Retrieve an instance of the DataImport object by it's ID.
{id:int}Unique identifier for the DataImport object.
POSTapi/v1/DataImport
Create a new instance of the DataImport object.
PUTapi/v1/DataImport/{id:int}
Update an existing instance of the DataImport object.