Commit eed7817e by nikhilbonte Committed by Ashutosh Mestry

ATLAS-3588 Export API- Update documentation

parent f484b205
...@@ -95,23 +95,36 @@ The _AtlasExportRequest_ below specifies the _fetchType_ as _FULL_. The _matchTy ...@@ -95,23 +95,36 @@ The _AtlasExportRequest_ below specifies the _fetchType_ as _FULL_. The _matchTy
<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> <SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
{`{ {`{
"itemsToExport": [ "itemsToExport": [
{ "typeName": "hive_db", "uniqueAttributes": { "qualifiedName": "accounts@" } }, { "typeName": "hive_db", "uniqueAttributes": { "qualifiedName": "accounts@" } }
], ],
"options" { "options": {
"fetchType": "FULL", "fetchType": "FULL",
"matchType": "startsWith" "matchType": "startsWith"
} }
}`} }`}
</SyntaxHighlighter> </SyntaxHighlighter>
The _AtlasExportRequest_ below specifies the _guid_ instead of _uniqueAttribues_ to fetch _accounts@cl1_.
<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
{`{
"itemsToExport": [
{ "typeName": "hive_db", "guid": "846c5e9c-3ac6-40ju-8289-fb0cebm64783" }
],
"options": {
"fetchType": "FULL",
}
}`}
</SyntaxHighlighter>
The _AtlasExportRequest_ below specifies the _fetchType_ as _connected_. The _matchType_ option will fetch _accountsReceivable_, _accountsPayable_, etc present in the database. The _AtlasExportRequest_ below specifies the _fetchType_ as _connected_. The _matchType_ option will fetch _accountsReceivable_, _accountsPayable_, etc present in the database.
<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> <SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
{`{ {`{
"itemsToExport": [ "itemsToExport": [
{ "typeName": "hive_db", "uniqueAttributes": { "name": "accounts" } }, { "typeName": "hive_db", "uniqueAttributes": { "qualifiedName": "accounts" } }
], ],
"options" { "options": {
"fetchType": "CONNECTED", "fetchType": "CONNECTED",
"matchType": "startsWith" "matchType": "startsWith"
} }
...@@ -165,11 +178,10 @@ Below are sample CURL calls that demonstrate Export of _QuickStart_ database. ...@@ -165,11 +178,10 @@ Below are sample CURL calls that demonstrate Export of _QuickStart_ database.
<SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}> <SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}>
{`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ {`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"itemsToExport": [ "itemsToExport": [
{ "typeName": "DB", "uniqueAttributes": { "name": "Sales" } { "typeName": "DB", "uniqueAttributes": { "name": "Sales" }},
{ "typeName": "DB", "uniqueAttributes": { "name": "Reporting" } { "typeName": "DB", "uniqueAttributes": { "name": "Reporting" }},
{ "typeName": "DB", "uniqueAttributes": { "name": "Logging" } { "typeName": "DB", "uniqueAttributes": { "name": "Logging" }}
}
], ],
"options": { "full" } "options": { "fetchType": "full" }
}' "http://localhost:21000/api/atlas/admin/export" > quickStartDB.zip`} }' "http://localhost:21000/api/atlas/admin/export" > quickStartDB.zip`}
</SyntaxHighlighter> </SyntaxHighlighter>
...@@ -38,8 +38,7 @@ Below are sample CURL calls that performs export operation on the _Sample HDFS S ...@@ -38,8 +38,7 @@ Below are sample CURL calls that performs export operation on the _Sample HDFS S
<SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}> <SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}>
{`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ {`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"itemsToExport": [ "itemsToExport": [
{ "typeName": "hdfs_path", "uniqueAttributes": { "name": "FinanceAll" } { "typeName": "hdfs_path", "uniqueAttributes": { "qualifiedName": "FinanceAll" } }
}
], ],
"options": { "options": {
"fetchType": "full", "fetchType": "full",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment