POST v1/BulkApi

Documentation for 'Post'.

Request Information

Parameters

NameDescriptionAdditional information
dto 
Documentation for 'dto'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "accountUploadType": "sample string 1",
  "data": {}
}

application/xml, text/xml

Sample:
Click to beautify! 
<BulkApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <AccountUploadType>sample string 1</AccountUploadType>
  <Data />
</BulkApi>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "records": [
    {
      "accountUploadId": 1,
      "status": "sample string 2",
      "data": "sample string 3",
      "details": "sample string 4",
      "createdEntityId": 1,
      "id": 5,
      "uri": "sample string 6"
    },
    {
      "accountUploadId": 1,
      "status": "sample string 2",
      "data": "sample string 3",
      "details": "sample string 4",
      "createdEntityId": 1,
      "id": 5,
      "uri": "sample string 6"
    },
    {
      "accountUploadId": 1,
      "status": "sample string 2",
      "data": "sample string 3",
      "details": "sample string 4",
      "createdEntityId": 1,
      "id": 5,
      "uri": "sample string 6"
    }
  ],
  "accountId": 1,
  "type": "sample string 2",
  "status": "sample string 3",
  "createdTimestamp": "2024-05-03T10:40:20.7590878+00:00",
  "completedTimestamp": "2024-05-03T10:40:20.7590878+00:00",
  "totalRecords": 1,
  "successfulRecords": 1,
  "failedRecords": 1,
  "totalProcessedRecords": 1,
  "processedRecords": 1,
  "failedProcessedRecords": 1,
  "importingTimestamp": "2024-05-03T10:40:20.7590878+00:00",
  "processedTimestamp": "2024-05-03T10:40:20.7590878+00:00",
  "fileName": "sample string 5",
  "reference": "sample string 6",
  "relatedId": 1,
  "internalAutomatedFlag": true,
  "modifiedTimestamp": "2024-05-03T10:40:20.7590878+00:00",
  "id": 9,
  "uri": "sample string 10"
}

application/xml, text/xml

Sample:
Click to beautify! 
<BulkApiAccountUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <Id>9</Id>
  <Uri>sample string 10</Uri>
  <AccountId>1</AccountId>
  <CompletedTimestamp>2024-05-03T10:40:20.7590878+00:00</CompletedTimestamp>
  <CreatedTimestamp>2024-05-03T10:40:20.7590878+00:00</CreatedTimestamp>
  <FailedProcessedRecords>1</FailedProcessedRecords>
  <FailedRecords>1</FailedRecords>
  <FileName>sample string 5</FileName>
  <ImportingTimestamp>2024-05-03T10:40:20.7590878+00:00</ImportingTimestamp>
  <InternalAutomatedFlag>true</InternalAutomatedFlag>
  <ModifiedTimestamp>2024-05-03T10:40:20.7590878+00:00</ModifiedTimestamp>
  <ProcessedRecords>1</ProcessedRecords>
  <ProcessedTimestamp>2024-05-03T10:40:20.7590878+00:00</ProcessedTimestamp>
  <Reference>sample string 6</Reference>
  <RelatedId>1</RelatedId>
  <Status>sample string 3</Status>
  <SuccessfulRecords>1</SuccessfulRecords>
  <TotalProcessedRecords>1</TotalProcessedRecords>
  <TotalRecords>1</TotalRecords>
  <Type>sample string 2</Type>
  <Records>
    <AccountUploadRecord>
      <Id>5</Id>
      <Uri>sample string 6</Uri>
      <AccountUploadId>1</AccountUploadId>
      <CreatedEntityId>1</CreatedEntityId>
      <Data>sample string 3</Data>
      <Details>sample string 4</Details>
      <Status>sample string 2</Status>
    </AccountUploadRecord>
    <AccountUploadRecord>
      <Id>5</Id>
      <Uri>sample string 6</Uri>
      <AccountUploadId>1</AccountUploadId>
      <CreatedEntityId>1</CreatedEntityId>
      <Data>sample string 3</Data>
      <Details>sample string 4</Details>
      <Status>sample string 2</Status>
    </AccountUploadRecord>
    <AccountUploadRecord>
      <Id>5</Id>
      <Uri>sample string 6</Uri>
      <AccountUploadId>1</AccountUploadId>
      <CreatedEntityId>1</CreatedEntityId>
      <Data>sample string 3</Data>
      <Details>sample string 4</Details>
      <Status>sample string 2</Status>
    </AccountUploadRecord>
  </Records>
</BulkApiAccountUpload>