[]
(Showing Draft Content)

SmartDocuments

SmartDocuments

[POST] /api/v2/smart-documents/import

Request Body

Type: multipart/form-data

Key Type Format Encoding
file string binary form

Responses

[200] Success

ImportDocumentResult

Type: [text/plain], [application/json], [text/json]

[POST] /api/v2/smart-documents/save-configuration

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SmartDocumentsMetadata

Responses

[200] Success

[GET] /api/v2/smart-documents/preview/{documentId}

Parameters

Name In Type
documentIdRequired path string
queryParams query object
pageIndex query integer

Responses

[200] Success

[GET] /api/v2/smart-documents/{id}

Parameters

Name In Type
idRequired path string

Responses

[200] Success

Models

Ƭ ImportDocumentResult

Name Type
success Boolean
documentIdNullable string
nameNullable string
titleNullable string
errorsNullable Array<string>

Ƭ SmartDocumentsMetadata

Name Type
documentIdNullable string
datasetsNullable Array<Dataset>
mappingsNullable Array<Mapping>
filteredFieldsNullable Array<FilteredField>
fieldsStructure Table

Ƭ Dataset

Name Type
idNullable string
nameNullable string
displayNameNullable string
fieldsNullable Array<Field>

Ƭ Mapping

Name Type
tagNameNullable string
fieldNameNullable string
datasetIdNullable string
isRepeatedNullable string

Ƭ FilteredField

Name Type
datasetIdNullable string
valueFieldNullable string

Ƭ Table

Name Type
keyNullable string
tablesNullable Array<Table>
columnsNullable Array<Column>
nameNullable string

Ƭ Field

Name Type
tableNullable string
columnNullable string
aliasNullable string
descriptionNullable string
dataTypeNullable string
dataVizAIHintNullable string
formatNullable string
fieldTypeNullable string
aggregationNullable string
rawTypeNullable string
msDescriptionNullable string
clrTypeNullable string
isContainTimeZoneNullable Boolean

Ƭ Column

Name Type
nameNullable string