PATCH Memo - API to handle large Data
- Last UpdatedJun 24, 2025
- 1 minute read
- Engineering
- Integration Service 4.0
- Integrators
Method: POST
URL: https://eu.ais.connect.aveva.com/data/api/v1.1/datasources/{productcategory}/{datasourcename}/data
Parameters:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
productcategory |
string |
Yes |
The name of the product category |
|
datasourcename |
string |
Yes |
The name of the data source |
|
path |
string |
Yes |
The type of data to being uploaded the Data source |
|
data |
string |
Yes |
Data to be uploaded in JSON String |
|
acknowledgementId |
string |
No |
Required during PATCH |
|
metadata |
string |
Yes |
Must be JSON string, should contain a property called "TotalNumberChunks" API should allocate |
Request:
{
"acknowledgementId": "",
"metadata": "{\"SizeOfChunk\":1000,\"TotalNumberOfChunk\":2}",
"path":"/tables",
"ChunkId": 1,
"data": "[{\"Name\":\"EQUIdfdfdsfPMENT\",\"Type\":\"PROCEDUafsdfdRE\"},{\"Name\":\"PIPE\",\"Type\":\"PROCqfqefeqrEDURE\"},{\"Name\":\"AIRCOOLEDHEsdasdasfATEXCHANGER_VIEW\",\"Type\":\"DbView\"}]"
}
Response: 200 OK
{
"acknowledgementId": "1b1b100a-7d59-4312-b489-2ae4361e0457"
}
Upload Chunk Data
Method: PATCH
URL: https://eu.ais.connect.aveva.com/data/api/v1.1/datasources/{productcategory}/{datasourcename}/memo/{acknowledgementId}
Parameters:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
productcategory |
string |
Yes |
The name of the product category |
|
datasourcename |
string |
Yes |
The name of the data source |
|
path |
string |
Yes |
The type of data to being uploaded the Data source |
|
data |
string |
Yes |
Data to be uploaded in JSON String |
|
acknowledgementId |
string |
YES |
Required during PATCH |
Request:
[
{
"operationType": "add",
"path": "/tables",
"value": {
"acknowledgementId": "1b1b100a-7d59-4312-b489-2ae4361e0457",
"metadata": {
"SizeOfChunk": 100,
"TotalNumberOfChunk": 2
},
"ChunkId": 2,
"data":"[{\"Name\":\"AIRCOOLEDHEATEXCHANGER\",\"Type\":\"PROCEDURE\"},
{\"Name\":\"ATMOSPHERICTANK\",\"Type\":\"PROCEDURE\"},
{\"Name\":\"CENTRIFUGALCOMPRESSOR\",\"Type\":\"PROCEDURE\"},
{\"Name\":\"CENTRIFUGALPUMP\",\"Type\":\"PROCEDURE\"}]"
}
}
]
Response: 200 OK
{
"acknowledgementId": "b1c7d8ea-f103-4735-91fd-129a4aa07929"
}