Mass Data Resource¶
Download Import Results¶
HTTP Request
POST /api/massData/import/{id}/download
📋 Description: Initiates the download of mass data import results for a specified identifier, enabling users to access and review the imported data efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Validate Import File¶
HTTP Request
POST /api/massData/import/validate
📋 Description: Validates the structure and content of mass data imports to ensure compliance with system requirements, facilitating accurate data integration and minimizing processing errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
importType |
query |
string |
true |
Type of the import |
body |
body |
object |
false |
Request body containing the mass data import specifications, including validation parameters and metadata for ensuring data integrity during the import process. |
» file |
body |
string(binary) |
true |
none |
Body Parameters
1{
2 "file": "string"
3}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "valid": true,
3 "errorMessage": "string"
4}
Process Import File¶
HTTP Request
POST /api/massData/import/upload
📋 Description: Uploads mass data files for import into the system, facilitating efficient data integration and management for enhanced operational workflows.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
importType |
query |
string |
true |
Type of the import |
description |
query |
string |
true |
Description of the resource |
body |
body |
object |
false |
Request body containing the mass data import files, including structured data sets and associated metadata for processing. |
» file |
body |
string(binary) |
true |
none |
Body Parameters
1{
2 "file": "string"
3}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Process Export File¶
HTTP Request
POST /api/massData/exportAllData
📋 Description: Exports all available data in bulk, enabling efficient data management and analysis for business operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
exportType |
query |
string |
true |
Type of the export |
description |
query |
string |
true |
Description of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Download Export Results¶
HTTP Request
POST /api/massData/export/{id}/download
📋 Description: Initiates the download of mass data export for the specified identifier, enabling users to efficiently access and utilize large datasets for analysis and reporting purposes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Find All Imported Mass Data¶
HTTP Request
GET /api/massData/importedRecords
📋 Description: Fetches a list of imported records from the mass data management system, enabling users to review and analyze data entries efficiently.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "fileName": "string",
7 "description": "string",
8 "categoryType": "string",
9 "startTime": "2019-08-24T14:15:22Z",
10 "endTime": "2019-08-24T14:15:22Z",
11 "status": "string",
12 "isImport": true
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a bulk data processing request, encapsulating essential parameters and metadata to facilitate efficient data handling and integration within enterprise systems.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» fileName |
string |
false |
none |
Name of the file |
» description |
string |
false |
none |
Description of the resource |
» categoryType |
string |
false |
none |
Type of the category |
» startTime |
string(date-time) |
false |
none |
Time of the start |
» endTime |
string(date-time) |
false |
none |
Time of the end |
» status |
string |
false |
none |
Status of the resource |
» isImport |
boolean |
false |
none |
Whether the resource is import |
Find All Exported Mass Data¶
HTTP Request
GET /api/massData/exportedRecords
📋 Description: Fetches exported records from the mass data repository, enabling users to access and analyze large datasets efficiently for informed decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "fileName": "string",
7 "description": "string",
8 "categoryType": "string",
9 "startTime": "2019-08-24T14:15:22Z",
10 "endTime": "2019-08-24T14:15:22Z",
11 "status": "string",
12 "isImport": true
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a bulk data processing request, encapsulating essential parameters and metadata to facilitate efficient data handling and integration within enterprise systems.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» fileName |
string |
false |
none |
Name of the file |
» description |
string |
false |
none |
Description of the resource |
» categoryType |
string |
false |
none |
Type of the category |
» startTime |
string(date-time) |
false |
none |
Time of the start |
» endTime |
string(date-time) |
false |
none |
Time of the end |
» status |
string |
false |
none |
Status of the resource |
» isImport |
boolean |
false |
none |
Whether the resource is import |
Find All Export Entity Types¶
HTTP Request
GET /api/massData/exportEntityTypes
📋 Description: Retrieves a list of entity types available for mass data export, enabling efficient data management and integration within your business processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Find All Entity Types¶
HTTP Request
GET /api/massData/entityTypes
📋 Description: Retrieves a list of available entity types within the mass data framework, enabling users to understand the data structures applicable to their business processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Download Template¶
HTTP Request
GET /api/massData/downloadTemplate
📋 Description: Downloads a predefined template for mass data uploads, facilitating streamlined data entry and ensuring consistency across submissions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
importTypeCategory |
query |
string |
true |
Category of the import type |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Delete Import¶
HTTP Request
DELETE /api/massData/import/{id}
📋 Description: Deletes a specified mass data import record by its unique identifier, facilitating the removal of outdated or erroneous data entries from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Delete Export¶
HTTP Request
DELETE /api/massData/export/{id}
📋 Description: Deletes the specified mass data export identified by the unique ID, ensuring the removal of outdated or unnecessary export records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |