POST v1/{subscriptionID}/projects/{projectID}/dataSources/async?recipientTableName={recipientTableName}

Creates a new data source.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

recipientTableName

The recipient table name. If provided then it will be adapted after data source creation.

string

Optional

Body Parameters

The data source to be created.

DataSourceModel
NameDescriptionTypeAdditional information
ID

Gets the data source ID.

globally unique identifier

None.

UProduceDataSourceID

Gets and sets the uProduce data source ID.

globally unique identifier

None.

FriendlyID

Gets the friendly ID of the data source.

string

None.

SubscriptionID

Gets the subscription ID of the document.

globally unique identifier

None.

IsRemote

Gets a value indicating whether the data source is a remote one.

boolean

None.

Name

Gets the data source name.

string

None.

CreationTime

Gets the creation time of the data source.

date

None.

Creator

Gets the user who created the data source.

UserViewModel

None.

ModificationTime

Gets the last modification time of the data source.

date

None.

Modifier

Gets the user who was the last to modify the data source.

UserViewModel

None.

FileToken

Gets and sets the data source file token.

FileTokenModel

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "19593819-b247-41b9-bf66-983a3d59fcac",
  "UProduceDataSourceID": "2a06ae96-2c97-4c87-a725-91ef0b002993",
  "FriendlyID": "sample string 3",
  "SubscriptionID": "0cf60d8d-c3a5-4001-a23a-cc260df1c2e7",
  "IsRemote": true,
  "Name": "sample string 6",
  "CreationTime": "2021-12-02T21:26:10.1690586Z",
  "Creator": {
    "ID": "85b78260-a0bd-4bdd-ac40-07002d2eea92",
    "Name": "sample string 2"
  },
  "ModificationTime": "2021-12-02T21:26:10.1690586Z",
  "Modifier": {
    "ID": "85b78260-a0bd-4bdd-ac40-07002d2eea92",
    "Name": "sample string 2"
  },
  "FileToken": {
    "Token": "sample string 1",
    "Type": 1,
    "FileName": "sample string 2",
    "FileType": 1
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataSourceModel'.

Response Information

Resource Description

Returns a request ID for the asynchronous data source creation.

AsyncRequestResultModel
NameDescriptionTypeAdditional information
RequestID

Gets the asynchronous request ID.

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "RequestID": "2bf0a86e-3c80-4743-8cec-38c85f74a966"
}