POST Api/Imports/ImportData

Request Information

URI Parameters

None.

Body Parameters

CustomImportDto
NameDescriptionTypeAdditional information
CustomImportId

integer

None.

Title

string

None.

Description

string

None.

ReportType

ReportTypeEnum

None.

Roles

string

None.

Params

Collection of FormParam

None.

RowsToSkip

integer

None.

ColumnNames

string

None.

ModelParams

Collection of Collection of FormParam

None.

InputFile

string

None.

Extension

string

None.

Request Formats

application/json, text/json

Sample:
{
  "customImportId": 1,
  "title": "sample string 2",
  "description": "sample string 3",
  "reportType": 0,
  "roles": "sample string 4",
  "params": [
    {
      "name": "sample string 1",
      "label": "sample string 2",
      "value": {},
      "required": true,
      "hidden": true,
      "typeOfField": 1
    },
    {
      "name": "sample string 1",
      "label": "sample string 2",
      "value": {},
      "required": true,
      "hidden": true,
      "typeOfField": 1
    }
  ],
  "rowsToSkip": 5,
  "columnNames": "sample string 6",
  "modelParams": [
    [
      {
        "name": "sample string 1",
        "label": "sample string 2",
        "value": {},
        "required": true,
        "hidden": true,
        "typeOfField": 1
      },
      {
        "name": "sample string 1",
        "label": "sample string 2",
        "value": {},
        "required": true,
        "hidden": true,
        "typeOfField": 1
      }
    ],
    [
      {
        "name": "sample string 1",
        "label": "sample string 2",
        "value": {},
        "required": true,
        "hidden": true,
        "typeOfField": 1
      },
      {
        "name": "sample string 1",
        "label": "sample string 2",
        "value": {},
        "required": true,
        "hidden": true,
        "typeOfField": 1
      }
    ]
  ],
  "inputFile": "sample string 7",
  "extension": "sample string 8"
}

multipart/form-data

Sample:
{"customImportId":1,"title":"sample string 2","description":"sample string 3","reportType":0,"roles":"sample string 4","params":[{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1},{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1}],"rowsToSkip":5,"columnNames":"sample string 6","modelParams":[[{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1},{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1}],[{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1},{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1}]],"inputFile":"sample string 7","extension":"sample string 8"}

application/xml, text/xml

Sample:
<CustomImportDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomImportId>1</CustomImportId>
  <Title>sample string 2</Title>
  <Description>sample string 3</Description>
  <ReportType>CSV</ReportType>
  <Roles>sample string 4</Roles>
  <Params>
    <FormParam>
      <Name>sample string 1</Name>
      <Label>sample string 2</Label>
      <Value />
      <Required>true</Required>
      <Hidden>true</Hidden>
      <TypeOfField>1</TypeOfField>
    </FormParam>
    <FormParam>
      <Name>sample string 1</Name>
      <Label>sample string 2</Label>
      <Value />
      <Required>true</Required>
      <Hidden>true</Hidden>
      <TypeOfField>1</TypeOfField>
    </FormParam>
  </Params>
  <RowsToSkip>5</RowsToSkip>
  <ColumnNames>sample string 6</ColumnNames>
  <ModelParams>
    <ArrayOfFormParam>
      <FormParam>
        <Name>sample string 1</Name>
        <Label>sample string 2</Label>
        <Value />
        <Required>true</Required>
        <Hidden>true</Hidden>
        <TypeOfField>1</TypeOfField>
      </FormParam>
      <FormParam>
        <Name>sample string 1</Name>
        <Label>sample string 2</Label>
        <Value />
        <Required>true</Required>
        <Hidden>true</Hidden>
        <TypeOfField>1</TypeOfField>
      </FormParam>
    </ArrayOfFormParam>
    <ArrayOfFormParam>
      <FormParam>
        <Name>sample string 1</Name>
        <Label>sample string 2</Label>
        <Value />
        <Required>true</Required>
        <Hidden>true</Hidden>
        <TypeOfField>1</TypeOfField>
      </FormParam>
      <FormParam>
        <Name>sample string 1</Name>
        <Label>sample string 2</Label>
        <Value />
        <Required>true</Required>
        <Hidden>true</Hidden>
        <TypeOfField>1</TypeOfField>
      </FormParam>
    </ArrayOfFormParam>
  </ModelParams>
  <InputFile>sample string 7</InputFile>
  <Extension>sample string 8</Extension>
</CustomImportDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json, multipart/form-data

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string>sample string 1</string>