Valuekeep Developers - Web API Reference

Framework | Import Data Info

Service to manage entities of type 'ImportDataInfo'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/importDataInfos
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET Validate Import Data State

Custom operation 'ValidateImportDataState'.

The following elements are required:

id (Guid) Id.

Response:

When successful, the response body contains a resource of type 'ImportDataInfoResource'. See ImportDataInfoResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /corePatterns/importDataInfos/validateImportDataState

GET Get Last Imports

Custom operation 'GetLastImports'.

The following elements are required:

templateId (string) TemplateId.

Response:

When successful, the response body contains a list of resources of type 'ImportDataInfoResource'. See ImportDataInfoResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /corePatterns/importDataInfos/getLastImports

POST Operations

POST Change Data Import

Custom operation 'ChangeDataImport'.

The following elements are required:

importData (ImportInfoResource) ImportData.

Response:

When successful, the response body is empty.

Resource URL:

POST /corePatterns/importDataInfos/changeDataImport

POST Revert Import File

Custom operation 'RevertImportFile'.

The following elements are required:

templateKey (string) TemplateKey.

Response:

When successful, the response body contains a resource of type 'RevertImport'. See RevertImport.

Resource URL:

POST /corePatterns/importDataInfos/revertImportFile

Resources


ImportDataInfoResource

The following elements are required:

key (int) The key for the import data info.
importDataTemplate (string) The template for the import data.

The following elements are optional:

originalFileName (string) The original file's name.
azureFileName (string) The azure file's name.
importDataState (enum ImportDataState) The import data's state.
See ImportDataState.
importName (string) The import's name.
detailLog (string) The detail's log.
error (string) The error.
lastProgressUpdateOn (DateTimeOffset) Contains the date time of the third party importer progress update.
drillDownOperation (string) Drill Down Operation.
reverted (bool) Reverted.


ImportInfoResource

The following elements are optional:

importId (Guid) The import data's identifier.
tenant (string) The tenant.
subscription (string) The subscription.
importDataState (enum ImportDataState) The import data's state.
See ImportDataState.
azureFileName (string) The azure file's name.
detailLog (string) The detail's log.
error (string) The error.
drillDownOperation (string) Drill Down Operation.


RevertImport

The following elements are required:

revertedTypeMessage (enum ReturnMessageType) Reverted Type Message.
See ReturnMessageType.
message (string) Message.


Enumerations


ImportDataState

1 Pending
2 Processing
3 Succeeded
4 Failed
5 Fatal