{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"scroll-ignore","parameters":{"macroParams":{"scroll-viewport":{"value":"true"},"scroll-pdf":{"value":"true"},"scroll-office":{"value":"true"},"scroll-chm":{"value":"true"},"scroll-docbook":{"value":"true"},"scroll-eclipsehelp":{"value":"true"},"scroll-html":{"value":"true"},"scroll-epub":{"value":"true"}},"macroMetadata":{"macroId":{"value":"5756812f-98f6-4fd4-bc9f-2ae911a13a05"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://scroll-exporter-extensions.addons.k15t.com/static/assets/images/macro-icons/scroll-ignore.svg"}}],"title":"Scroll Ignore"}},"localId":"c8698269-292f-416d-b36c-38d2a87d7fe7"},"content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Open in new tab","type":"text","marks":[{"type":"link","attrs":{"href":"https://kada-knowledge-library.scrollhelp.site/home/API-Guides.1889435750.html"}}]}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"57802dcd-6a15-4e7d-b01b-fafc21850380"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"8727f076-0aa6-4f64-a1c7-ca078eaa24d6"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Get Access Token","type":"text"}]},{"type":"paragraph","content":[{"text":"The access token is used in the request header ","type":"text"},{"text":"Authorization: Bearer ","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"# REPLACE: , \ncurl -X POST -u \"know-app:\" \\\n -d \"grant_type=password&username=&password=&scope=openid profile email\" \\\n https:///keycloak/auth/realms/kada/protocol/openid-connect/token\n \n# Response. The access_token will be used to authenticate API calls to KADA.\n{\n \"access_token\": \"..\",\n \"expires_in\": 7200,\n \"refresh_expires_in\": 86400,\n \"refresh_token\": \"...\",\n \"token_type\": \"bearer\",\n \"id_token\": \"...\",\n \"not-before-policy\": 0,\n \"session_state\": \"...\",\n \"scope\": \"openid profile email\"\n}\n\nexport ACCESS_TOKEN=","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Get an object","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the table with name ‘customer’","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request GET 'https:///api/tables?name=customer' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Get fully qualified table name: table123, in schema3 in db2 in host1.","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request GET 'https:///api/tables?signature=host1.db2.schema3.table123' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Updating a description ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" can be found from the Get object call. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location --request PUT 'https:///api/tables/

' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"description\": \"Add your description here\",\n \"replace_date\": null\n}'","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Adding a tag to a table","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a tag","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location --request POST 'https:///api/tags' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"description\": \"Add your tag description here\",\n \"name\": \"tag_name\"\n}'","type":"text"}]},{"type":"paragraph","content":[{"text":"Link the tag to an object.","type":"text"}]},{"type":"paragraph","content":[{"text":"

","type":"text","marks":[{"type":"code"}]},{"text":" is returned from the Get object call","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is returned from the Get Tags or Create tag call","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request PUT 'https:///api/tables//related?object_id=&relationship=TAGGED_BY' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete a tag from an object","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request DELETE 'https:///api/tables//related?object_id=&relationship=TAGGED_BY' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Adding a property to a object","type":"text"}]},{"type":"paragraph","content":[{"text":"A property name is unique for a given object","type":"text"}]},{"type":"paragraph","content":[{"text":"

","type":"text","marks":[{"type":"code"}]},{"text":" the table being linked to the collection","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" the collection instance being linked.","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request PUT 'https:///api/tables/

/related?object_id=&relationship=MEMBER_OF' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Adding and Steward to a table","type":"text"}]},{"type":"paragraph","content":[{"text":"Similarly to add an owner use the relationship ","type":"text"},{"text":"relationship=OWNED_BY","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request PUT 'https:///api/tables/

/related?object_id=&relationship=STEWARDED_BY' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Creating manual lineage to an upstream table","type":"text"}]},{"type":"paragraph","content":[{"text":"

","type":"text","marks":[{"type":"code"}]},{"text":" this is the downstream table. Use Get to find the table id.","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" this is the source table. Use Get to find the table id","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --location \\\n --request PUT 'https:///api/tables/

/related?object_id=&relationship=SOURCE_FROM' \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\"","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported