- Knowledge Base
- Developer's Zone
- Rest API 5.0
-
Roadmap
-
Knowledgebase Documents
-
Installation and System Setup
-
Setup Data Catalog
-
Connectors
-
Data Discovery
-
Self Service
-
Access Management
-
Data Quality
-
Data Literacy
-
Privacy Compliance
-
Reporting
-
Architecture, Security & Releases
-
Developer's Zone
-
Advanced Tools
-
Record of Processing Activities (ROPA)
-
Others
-
Release6.0 User Guide
-
Release6.1 Features
-
Data Catalog
-
News
-
Deactivated_Old
-
Release6.3 Deep Dive Articles
Story Services
Available API's under Story services are:
- Add Story API
- Update Story API
1. Add Story API
This API adds given stories under the story zone specified in the path.
Mandatory Field: owner, storyDescription, storyName, storyZone.
Method | URL |
addStories |
/api/story/add |
Request Body
[
{
"isEncodedText": true,
"owner": "string",
"path": "string",
"story": "string"
}
]
Example
[
{
"isEncodedText": false,
"owner": "admin",
"path": "ovaledge/Story From API",
"story": "This is a story created from API"
}
]
Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"Status": {
"ovaledge/Story From API": "Success"
}
}
}
2. Update Story API
This API updates story information.
Mandatory Field: descriptionToSaveOrUpdate, owner, storyDescription, storyId.
Method | URL |
udpateStory |
/api/story/{storyId} |
Request Body
{
"descriptionToSaveOrUpdate": "string",
"isEncodedText": true,
"owner": "string",
"story": "string"
}
Example
{
"descriptionToSaveOrUpdate": "string",
"isEncodedText": true,
"owner": "admin",
"story": "Updating the new article story with latest info"
}
Response Body
{
"status": true,
"statusCode": "Updated Successfully",
"statusMsg": "",
"response": {}
}