Use Data API

GET

/datasources

-

Retrieves the list of data sources

GET

/datasources/{datasourcename}

-

Retrieves the details of the specified data source

Note: Data source name is the unique identifier for a data source.

GET

/datasources/{productcategory}

-

Retrieve list of all data sources configured for the specified Product Category.

Note: Product Category must be from the the List of Values:[ Engineering, E3D, Electrical, ERM, Instrumentation, NET_Portal, PnID, PROII, Process_Simulation, ETAP, Excel, Oracle, SQL_Server, Other ]

GET

/datasources/{productcategory}/{datasourcename}

-

Retrieves the specified data source for the specified Product Category

PATCH

/datasources/{productcategory}/{datasourcename}

[

{

"op": "replace",

"path": "/tables",

"value": "json of tables"

},

{

"op": "add",

"path": "/acknowledgements",

"from": "",

"value": "acknowledgementid"

}

]

Updates the data source properties

POST

/datasources/{productcategory}/{datasourcename}/datarequest

{

"path": "/tables"

}

Requests data from specific data source

POST

/datasources/{productcategory}/{datasourcename}/data

{

"acknowledgementId": "",

"metadata": "List Of tables",

"Path": "/tables",

"data":"[{\"Name\":\"EQUIPMENT\",\"Type\":\"PROCEDURE\"},{\"Name\":\"PIPE\",\"Type\":\"PROCEDURE\"},{\"Name\":\"AIRCOOLEDHEATEXCHANGER_VIEW\",\"Type\":\"DbView\"}]"

}

Posts data to Data API.

GET

/datasources/{productcategory}/{datasourcename}/acknowledgements

Retrieves list of acknowledgements

GET

/datasources/{productcategory}/{datasourcename}/acknowledgements/{acknowledgementid}

Retrieves data for specific data source identified by acknowledgementid

POST

/datasources/{productcategory}/{datasourcename}/memo

{

"topic":"E3D-Design-APS",

"context":"new data available"

}

Posts message/memo.

GET

/{dataSourceName}/acknowledgements/{acknowledgementId}/chunks

Retrieves the no.of chunks available in Data API.

GET

/{dataSourceName}/acknowledgements/{acknowledgementId}/chunks/{chunkId}

Retrieves the specific chunk data from Data API

PATCH

/{dataSourceName}/memo/{acknowledgementId}

[{

"operationType": "add",

"value": {

"acknowledgementId": "XXXXX",

"metadata": {

"SizeOfChunk": 1000,

"IndexOfChunk": 2,

"TotalNumberOfChunk": 100

},

"TableName": "Q-SPEC",

"ChunkId": "2",

"path": "/Table",

"data": "XXXXXX",

"Topic": "XXXXXX",

"Context": "XXXXXX"

}

}]

It will be used to append the chunk to exiting data in Data API in case of large data handling