![](\"https://epi-docs.s3.us-east-2.amazonaws.com/public/postman/Walacor.jpg\")
\n\nThe Platform API is based on a standard REST API format and should be familiar to most developers.
\nAs with any documentation, this is a work in progress and we are always willing to accept feedback about the documentation or the API itself.
\nAn Enterprise level secure data platform.
The Database looks and feels while integrating industry best practices, including blockchain, to provide a quantum resistant tamper-proof data repository.
A primary design goal of the API was to allow an interaction that would be familiar to developers to enable ease of use and facilitate adoption.
\nHowever, there is a lot going on under the hood, and it is important to gain some knowledge to make best use of The Platform and the API.
\nOn the top level \"Walacor API Documentation\" goto the variables tab.
\nEnter the following information
\nServer - This is the URI to your server, NO Trailing Slash
\nUsername
\nPassword
\nThe other variables mentioned here are used for internal processing and testing.
\nYou can now run requests in the collection.
\nBecause the platform integrates blockchain, an important difference that you must be aware of is immutability. EVERYTHING (Data, Schema, Users, etc.) submitted to the platform is part of a never-changing audit log that can never be deleted.
\nThe Platform handles the heavy lifting of this for you and, in general, allows you to interact with it as you would with most databases. However, it is best to keep this in mind when doing things like Schema design.
\nExample 1: You have a data structure, I.E. schema, that you add to The Platform. Internally this get a DV (Data Version), or SV (Schema Version), of 1. Then you make changes to it and it gets a DV, SV, of 2. DV = 1 still exists, and potentially can be used, so it is best to not do prototyping in The Platform, especially on a production system.
\nExample 2: You have a data structure, I.E. schema, that you add to The Platform. At a later time you wish to delete it. Due to immutability being part of the core engine, this is not possible.
\nIt is always recommended to use a development environment until thing stabilize and then move it to the production environment.
\nAn \"Envelope\" is the standard way that all components of The Platform talk with each other, including the API. This enables code and processes to be shared/reused across components.
\nFrom a technical standpoint the envelope is a JSON object with a specific format that is used for the basis of all inter process communication and API calls.
\nThe basic format of an envelope is a header that informs The Platform of a general context of the call and then 1 or more data objects in an array the are specific to the call being made. The combination of the API end point, the header context and the content in data actions can be performed.
\n{\n \"ETId\" : 10,\n \"DV\" : 1,\n \"Data\" : [\n { \"JSON\":\"Object\" },\n { \"JSON\":\"Object\" }\n ]\n}\n\n{\n \"success\": true or false,\n \"errors\": \n {\"code\":number, \n \"errors\": [\n { \"reason\" : error category,\n \"message\" : description of the error },\n { \"reason\" : error category,\n \"message\" : description of the error }\n ]\n }\n}\n\nThese are special envelope type that are controlled by the platform and cannot be modified except by code change.
\nTo run APIs in the Walacor project, the \"currentAccessToken\" value must be modified, which expires in 24 hours. As explained below, the value can be acquired from the \"Login\" API option \"api_token.\"
\na) Copying \"api_token\" value from Login API:
\n![](\"https://epi-docs.s3.us-east-2.amazonaws.com/public/postman/pm1.jpeg\")
\n\nb) Selecting the Environment:
\n![](\"https://epi-docs.s3.us-east-2.amazonaws.com/public/postman/pm2.jpeg\")
\n\nc) Edit window to change “currentAccessToken”
\n![](\"https://epi-docs.s3.us-east-2.amazonaws.com/public/postman/pm3.jpeg\")
\n\nd) Replacing the “currentAccessToken” value.
\n![](\"https://epi-docs.s3.us-east-2.amazonaws.com/public/postman/pm4.jpeg\")
\n\nNow, the user can test any functional API, and the desired output will be displayed.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome to the API for The Walacor Platform","slug":"welcome-to-the-api-for-the-walacor-platform"},{"content":"The Platform","slug":"the-platform"},{"content":"Postman - Configuration to use this collection","slug":"postman-configuration-to-use-this-collection"},{"content":"Immutability","slug":"immutability"},{"content":"The Envelope","slug":"the-envelope"},{"content":"Request Returns","slug":"request-returns"},{"content":"ERROR CODES","slug":"error-codes"},{"content":"System Envelope Types","slug":"system-envelope-types"},{"content":"OLD!! - Postman - Configuration to run APIs - OLD!!","slug":"old-postman-configuration-to-run-apis-old"}],"owner":"8913941","collectionId":"8c6292f0-f2d7-4f54-afb6-5918767216f9","publishedId":"U16dQoKo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-10-21T19:17:23.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","id":"de1aef92-e4ca-4a28-9697-dac9723c2876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Referer","value":"Probably not required
\n"}],"body":{"mode":"raw","raw":"{\"userName\":\"use the bearer token for the rest
\n","urlObject":{"path":["api","auth","login"],"host":["{{dev2}}"],"query":[],"variable":[]}},"response":[{"id":"23e5f941-4d04-458e-b124-7ccc3f58cf67","name":"Login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Referer","value":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json","description":"To Define the type of Content
\n"}],"body":{"mode":"raw","raw":""},"url":"Get Users API can be used to display the user's information (e.g., their own profile).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","query","get"],"host":["set query parameter to get response(summary,audit, history)
\n","type":"text/plain"},"key":"from","value":"history"}],"variable":[]}},"response":[{"id":"9ea1110a-a18a-4d8b-901b-90757b9a979a","name":"Get Users","originalRequest":{"method":"POST","header":[{"key":"ETId","value":"10"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"To define the type of content
\n"},{"key":"ETId","value":"10","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 10,\r\n \"Data\": [\r\n {\r\n \"UserName\": \"testusernew0\",\r\n \"FirstName\": \"test\",\r\n \"LastName\": \"user\",\r\n \"Password\": \"Password1\"\r\n }\r\n ]\r\n}"},"url":"Add User API can be used to onboard user (e.g., generating credentials and storing information to control access).
\nAdd User will let the admin to create a new user with entering user details like User Name, First Name, Last Name and Password.
\nPresently, have introduced below actions :-
\nEdit User Detail allows to edit user first & last name and Role.
\nNote: Admin can’t change the User Name & block chain address. Block chain address is assigned by default while creating the user.
\nAction Add User Role allows to assign more roles to the user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","envelopes","submit"],"host":["Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","type":"text","description":"The version of the data part of the envelope
\n"},{"key":"Content-Type","value":"application/json"},{"key":"UserName","value":"50"}],"body":{"mode":"raw","raw":"{\r\n \"oldPassword\": \"epic@pw_20201\",\r\n \"newPassword\": \"epic@pw_2020\",\r\n \"confirmPassword\": \"epic@pw_2020\"\r\n}","options":{"raw":{"language":"json"}}},"url":"User management enables admins to control user access and on-board and off-board users.
\nThe purpose of User Management is to give an administrator the authorization to see which user details exist in the system. An Admin can add a new user, assign a role to the new user, and edit the user details.
\nIt contains certain modules like getUsers & addUser to display the user's information and add new users to the system, respectively.
\nAdd User will let the admin create a new user by entering user details like User Name, First Name, Last Name and Password.
\nSearch is applicable on User Name & First Name.
\nFilter by Account Locked lets the admin fetch the list of all users who have the combination of enabled and disabled by selecting All from dropdown list. Enabled, shows the result of only enabled users who can access the application. Selection of Disabled from the dropdown list shows the result of disabled users only whose access is locked to get into the application.
\nThe Account Locked column shows the check boxes against each user. Checked account Locked shows that the individual user has been locked and doesn’t have access to the application. Unchecked are the users who have access to the application.
\nChange Password
\nChange Password is a feature that gives admin/site_admin the authority to change the passwords of the users who exist in the system. The Admin cannot see the current password of the user but can set a new password for the user.
\nIf the admin sets the password for the user. In this case, when a user logs in to the application with password given by the admin, It will ask the user to reset the password just after the login. Resetting password is mandatory to get into the application.
\n","_postman_id":"5822a761-1f67-4687-82bc-ec8967cb876b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Role Management","item":[{"name":"Get Roles","id":"facac47c-83ad-43ae-a5aa-114edcd69781","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"etid","value":"15","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"url":"To define the type of content
\n"},{"key":"ETId","value":"15","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 15,\r\n \"Data\": [\r\n {\r\n \"RoleName\": \"CoAdmin\",\r\n \"Scopes\": [\r\n \"WriteOnly\"\r\n ]\r\n }\r\n ]\r\n}"},"url":"Add Role allows the admin to create new role with just naming to the role and add the scope. Admin can map either one or multiple scopes to Role.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","envelopes","submit"],"host":["To define the type of content
\n"},{"key":"etid","value":"16","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"sv","value":"1","description":"Document Version
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 16,\r\n \"Data\": [\r\n {\r\n \"RoleID\": \"1779648e-91a3-484f-bf02-22d727ef96f1\",\r\n \"UserUID\": \"2a9b1e2a-6b6b-4f12-b718-2191fd8de6b9\"\r\n },\r\n {\r\n \"RoleID\": \"a3a0c3cd-075f-40da-b593-aab0a02f7712\",\r\n \"UserUID\": \"2a9b1e2a-6b6b-4f12-b718-2191fd8de6b9\"\r\n },\r\n {\r\n \"RoleID\": \"c7a478b4-8c25-44e5-8182-91f8f2a8a84f\",\r\n \"UserUID\": \"2a9b1e2a-6b6b-4f12-b718-2191fd8de6b9\"\r\n }\r\n ]\r\n}"},"url":"Role management's goal is to create new roles based on scopes, edit existing roles, assign a role to the new user (s), edit the user's role, and remove the user from the current role.
\nRoles are listed with information such as the role name, mapped scopes to the specific role, and the time stamp of role creation and updating.
\nThe position or purpose that someone or something has in a situation, organization, society, or relationship. Examples: Admin, User etc.
\nScope is defined in 3 categories
\nAdd Role allows the admin to create a new role by just naming the role and adding the scopes from the dropdown. An Admin can map either one or multiple scopes to a Role.
\nRole Info lets the admin edit the scopes to the role.
\nAction Add the role to only new users allows you to assign the role to the new users whom it has not yet been assigned. As a result, the Users dropdown list would contain a list of users who are not assigned to any role.
\nEdit Role
\nAdmin can edit the role name and scope of the existing role. Though you can assign/unassign the multiple scopes to the role. Role list will be updated as per the changes after saving it.
\n","_postman_id":"67b90fcf-7927-48e9-b203-a12f786ac7cd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Schema (Data Structure)","item":[{"name":"Fields","item":[{"name":"Get DataType","id":"f8f526d4-24aa-4de1-9469-25f451b3b5d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This is a list of all field data types supported by the Platform
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","schemas","dataTypes"],"host":["These fields are automatically add to every schema submitted to the platform.
\nThey are not optional. They are maintained by the Platform and should not be updated directly.
\nYou can use them in queries.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","schemas","systemFields"],"host":["These give details about the possible field types and system generated fields
\n","_postman_id":"735aa10f-bf1e-4bdb-b555-1f0ced41a0c2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Schema UI - Data","item":[{"name":"Get List with Latest Version","id":"6c1a4bc7-acf8-4445-82d6-06ebca2eebf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n","type":"text/plain"},"type":"any","value":"10000","key":"ETId"}]}},"response":[{"id":"b0b83dc8-0fad-4084-bba1-3429c1fb0430","name":"Get Versions For ETId","originalRequest":{"method":"GET","header":[],"url":{"raw":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","description":"The version of the data part of the envelope
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 50,\r\n \"SV\": 1,\r\n \"Schema\": {\r\n \"ETId\": 10000000,\r\n \"TableName\": \"authors\",\r\n \"Family\": \"Pubs\",\r\n \"DoSummary\": true,\r\n \"Fields\": [\r\n {\r\n \"FieldName\": \"au_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"au_lname\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"au_fname\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"phone\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"address\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048\r\n },\r\n {\r\n \"FieldName\": \"city\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048\r\n },\r\n {\r\n \"FieldName\": \"state\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2\r\n },\r\n {\r\n \"FieldName\": \"zip\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 5\r\n },\r\n {\r\n \"FieldName\": \"contract\",\r\n \"DataType\": \"BOOLEAN\",\r\n \"MaxLength\": 1,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"IsDeleted\",\r\n \"DataType\": \"BOOLEAN\",\r\n \"Default\": false\r\n }\r\n ],\r\n \"Indexes\": [\r\n {\r\n \"Fields\": [\r\n \"au_id\"\r\n ],\r\n \"IndexValue\": \"au_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","description":"The version of the data part of the envelope
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 50,\r\n \"SV\": 1,\r\n \"Schema\": {\r\n \"ETId\": 10000001,\r\n \"TableName\": \"publishers\",\r\n \"Family\": \"Pubs\",\r\n \"DoSummary\": true,\r\n \"Fields\": [\r\n {\r\n \"FieldName\": \"pub_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"pub_name\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": false\r\n },\r\n {\r\n \"FieldName\": \"city\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"state\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2\r\n },\r\n {\r\n \"FieldName\": \"country\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 30\r\n }\r\n ],\r\n \"Indexes\": [\r\n {\r\n \"Fields\": [\r\n \"pub_id\"\r\n ],\r\n \"IndexValue\": \"pub_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","description":"The version of the data part of the envelope
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 50,\r\n \"SV\": 1,\r\n \"Schema\": {\r\n \"ETId\": 10000002,\r\n \"TableName\": \"titles\",\r\n \"Family\": \"Pubs\",\r\n \"DoSummary\": true,\r\n \"Fields\": [\r\n {\r\n \"FieldName\": \"title_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"title\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"type\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"pub_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048\r\n },\r\n {\r\n \"FieldName\": \"price\",\r\n \"DataType\": \"DECIMAL\",\r\n \"MaxLength\": 10,\r\n \"Decimals\" : 2\r\n },\r\n {\r\n \"FieldName\": \"advance\",\r\n \"DataType\": \"DECIMAL\",\r\n \"MaxLength\": 10,\r\n \"Decimals\" : 2\r\n },\r\n {\r\n \"FieldName\": \"royalty\",\r\n \"DataType\": \"INTEGER\",\r\n \"MaxLength\": 10\r\n },\r\n {\r\n \"FieldName\": \"ytd_sales\",\r\n \"DataType\": \"INTEGER\",\r\n \"MaxLength\": 10\r\n },\r\n {\r\n \"FieldName\": \"notes\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048\r\n },\r\n {\r\n \"FieldName\": \"pubdate\",\r\n \"DataType\": \"DATETIME(EPOCH)\"\r\n }\r\n ],\r\n \"Indexes\": [\r\n {\r\n \"Fields\": [\r\n \"title_id\"\r\n ],\r\n \"IndexValue\": \"title_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n },\r\n {\r\n \"Fields\": [\r\n \"pub_id\"\r\n ],\r\n \"IndexValue\": \"pub_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","description":"The version of the data part of the envelope
\n"}],"body":{"mode":"raw","raw":"{\r\n \"ETId\": 50,\r\n \"SV\": 1,\r\n \"Schema\": {\r\n \"ETId\": 10000003,\r\n \"TableName\": \"titleauthor\",\r\n \"Family\": \"Pubs\",\r\n \"DoSummary\": true,\r\n \"Fields\": [\r\n {\r\n \"FieldName\": \"au_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"title_id\",\r\n \"DataType\": \"TEXT\",\r\n \"MaxLength\": 2048,\r\n \"Required\": true\r\n },\r\n {\r\n \"FieldName\": \"au_ord\",\r\n \"DataType\": \"INTEGER\"\r\n },\r\n {\r\n \"FieldName\": \"royaltyper\",\r\n \"DataType\": \"INTEGER\"\r\n }\r\n ],\r\n \"Indexes\": [\r\n {\r\n \"Fields\": [\r\n \"au_id\"\r\n ],\r\n \"IndexValue\": \"au_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n },\r\n {\r\n \"Fields\": [\r\n \"title_id\"\r\n ],\r\n \"IndexValue\": \"title_id\",\r\n \"ForceUpdate\": false,\r\n \"Delete\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Northwind examples are given in the next few sections in order to give structure and a story line for schema creation, data insertion and data query.
\nThis is directly based on the Northwind sample database that has been used by Microsoft for sometime with it's database products.
\n","_postman_id":"ad904a45-5873-4abc-9405-889081002b14","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}}],"id":"da8d5084-9612-4f23-9710-6a1cbd9ae430","_postman_id":"da8d5084-9612-4f23-9710-6a1cbd9ae430","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Schema Details","item":[{"name":"Northwind","item":[{"name":"Get Schema Details - Northwind - Authors","id":"9461c8ba-880e-4cd0-ba14-2acd6563653a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ETid","value":"10000000"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"Lists all of the ETid's (Schemas) present in the database.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","schemas","envelopeTypes"],"host":["Schema are similar to tables or collections in other databases.
\nSome Important Terms:
\nAllowed Data Types:
\nThe idea of a schema is based on a database.
\nYou have fields, fields have options, fields belong to schemas (Tables), Schemas have options
TBD - Schemas belong to schema collections (Tables)
Modeling this off from existing database look and feel will help adoption.
\nMYSQL admin screen has:
\nYou can send multiple records in one call and it does improve performance.
\nThere are some ramifications when you do this that you need to understand:
\nYou can send multiple records in one call and it does improve performance.
\nThere are some ramifications when you do this that you need to understand:
\nYou can send multiple records in one call and it does improve performance.
\nThere are some ramifications when you do this that you need to understand:
\nYou can send multiple records in one call and it does improve performance.
\nThere are some ramifications when you do this that you need to understand:
\nEnvelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"au_id\": \"238-95-7766\"\r\n}"},"url":"The Simple query endpoint is based on MongoDB Find() command.
\nAll of the capabilities that are possible with Mongo find query parameter are supported.
\ndb.collection.find(query, projection, options)
\nInclude the desired query parameter in the body of the request.
\nFor reference a link to the MongoDB documentation for find is included below.
\n\n","_postman_id":"65ec18a5-51aa-4261-baf0-6efc20dcad7b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Complex","item":[{"name":"Get Titles With Publisher Name","id":"1a97b6a8-6595-4bc3-b8c1-1bfcdbebcfde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ETId","value":"10000002","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field. For a getcomplex this is the primary table the query is based on.
\n"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"$lookup\": {\r\n \"from\": \"10000001_publishers\",\r\n \"localField\": \"pub_id\",\r\n \"foreignField\": \"pub_id\",\r\n \"as\": \"pubs\"\r\n }\r\n },\r\n {\r\n \"$unwind\": \"$pubs\"\r\n },\r\n {\r\n \"$sort\": {\r\n \"pubs.pub_name\": 1,\r\n \"title\": 1\r\n }\r\n },\r\n {\r\n \"$project\": {\r\n \"_id\": 0,\r\n \"Publisher\": \"$pubs.pub_name\",\r\n \"Title\": \"$title\"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"The getcomplex endpoint allows pass through of MQL Aggregate syntax to the cache database. This allows complex queries.
\nIf you are familiar with how MQL queries work then you can do this.
\nA couple of notes:
\nEnvelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"$lookup\": {\r\n \"from\": \"10000001_publishers\",\r\n \"localField\": \"pub_id\",\r\n \"foreignField\": \"pub_id\",\r\n \"as\": \"pubs\"\r\n }\r\n },\r\n {\r\n \"$lookup\": {\r\n \"from\": \"10000003_titleauthor\",\r\n \"localField\": \"title_id\",\r\n \"foreignField\": \"title_id\",\r\n \"as\": \"title_auth\"\r\n }\r\n },\r\n {\r\n \"$lookup\": {\r\n \"from\": \"10000000_authors\",\r\n \"localField\": \"title_auth.au_id\",\r\n \"foreignField\": \"au_id\",\r\n \"as\": \"auth\"\r\n }\r\n },\r\n {\r\n \"$unwind\": \"$pubs\"\r\n },\r\n {\r\n \"$sort\": {\r\n \"pubs.pub_name\": 1,\r\n \"title\": 1,\r\n \"auth.au_fname\": 1\r\n }\r\n },\r\n {\r\n \"$project\": {\r\n \"_id\": 0,\r\n \"Publisher\": \"$pubs.pub_name\",\r\n \"Title\": \"$title\",\r\n \"Authors\": \"$auth.au_lname\"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"The getcomplex endpoint allows pass through of MQL Aggregate syntax to the cache database. This allows complex queries.
\nIf you are familiar with how MQL queries work then you can do this.
\nA couple of notes:
\nThe complex query endpoint is based on MongoDB Aggregate() command.
\nAll of the capabilities that are possible with Mongo aggregate pipeline parameter are supported.
\ndb.collection.aggregate(pipeline, options)
\nInclude the desired pipeline parameter in the body of the request.
\nFor reference a link to the MongoDB documentation for aggregate is included below.
\n\n","_postman_id":"59f5ac5c-2548-423c-81e0-12f22a501ee3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}}],"id":"d5cd0f59-84ac-41aa-aabf-dc5fb286b98a","_postman_id":"d5cd0f59-84ac-41aa-aabf-dc5fb286b98a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Query API","id":"ca638dbf-7e2c-4a59-a4da-f070315732bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ETId","value":"10","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UID\": \"671f0357-d7e7-4101-a68b-166f52444fe5\",\r\n \"isDeleted\": false\r\n}"},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"$match\" : {\"UID\" : \"49ffdb0c-7151-4be0-8d19-50c90cda1042\"}\r\n },\r\n {\r\n \"$sort\": { \"CreatedAt\" : -1}\r\n },\r\n {\r\n \"$project\": {\r\n \"_id\": \"$_id\",\r\n \"EId\":\"$EId\",\r\n \"ORGId\":\"$ORGId\",\r\n \"UID\":\"$UID\",\r\n \"directory_UID\": \"$directory_UID\",\r\n \"user_UID\":\"$user_UID\",\r\n \"description\": \"$description\",\r\n \"CreatedAt\": \"$CreatedAt\",\r\n \"Filename\": \"$filename\",\r\n \"isPublic\" : \"$isPublic\"\r\n }\r\n },\r\n {\r\n \"$skip\": 0\r\n },\r\n {\r\n \"$limit\": 1\r\n }\r\n]\r\n"},"url":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"$match\": {\r\n \"DocumentUID\": \"3c36ea15-1869-419a-9668-56aad95363c4\"\r\n }\r\n },\r\n {\r\n \"$lookup\": {\r\n \"from\": \"10000_document\",\r\n \"localField\": \"DocumentUID\",\r\n \"foreignField\": \"UID\",\r\n \"as\": \"document\"\r\n }\r\n },\r\n {\r\n \"$sort\": {\r\n \"CreatedAt\": -1\r\n }\r\n },\r\n {\r\n \"$project\": {\r\n \"_id\": 1,\r\n \"Description\": \"$Description\",\r\n \"DocumentUID\": \"$DocumentUID\",\r\n \"DocumentLink\": \"$DocumentLink\",\r\n \"CreatedAt\": \"$CreatedAt\",\r\n \"FileName\": \"$document.name\",\r\n \"Signature\": \"$document.md5\",\r\n \"EId\":\"$document.EId\"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"The getcomplex endpoint allows pass through of MQL Aggregate syntax to the cache database. This allows complex queries.
\nIf you are familiar with how MQL queries work then you can do this.
\nA couple of notes:
\nThere are 2 endpoints that are used for queries: one for simple lists and another for more complex requests.
\n","_postman_id":"06a6411f-828b-47b5-92f1-550885110ae9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"File (Binary) Requests","item":[{"name":"V1.5","item":[{"name":"Verify","event":[{"listen":"test","script":{"id":"e79a607b-6abb-4ecb-a38e-2923a8cca81d","exec":["var responBody = pm.response.json();\r","\r","var binary_request = responBody.data; \r","\r","pm.collectionVariables.set(\"Binary_response\", JSON.stringify(binary_request));\r","\r","console.log(binary_request);\r","\r","\r",""],"type":"text/javascript"}}],"id":"a9de9af5-8eac-430f-853d-a09a33e4880e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/C:/Users/whancock/Downloads/Microsoft_Action_Pack_license_table_09_2022.pdf"}]},"url":"The verify endpoint sends a complete file to the server.
\nThis file is then validated and checked against existing files to ensure it is not a duplicate.
\nThe duplicate comparison is done at the bit level (I.E. the file contents) and not the meta data associated with the file (Name, date, etc...). The Platform will not allow duplicate files to be stored.
\nIf a duplicate is found, the details of that duplicate file will be returned.
\nThe \"fileInfo\" object that is returned is to be passed to Store in order to commit the file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","v2","files","verify"],"host":["The verify endpoint sends a complete file to the server.
\nThis file is then validated and checked against existing files to ensure it is not a duplicate.
\nThe duplicate comparison is done at the bit level (I.E. the file contents) and not the meta data associated with the file (Name, date, etc...). The Platform will not allow duplicate files to be stored.
\nIf a duplicate is found, the details of that duplicate file will be returned.
\nThe \"fileInfo\" object that is returned is to be passed to Store in order to commit the file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","v2","files","verify2"],"host":["Store is used to commit a file that has been previously sent to the server using Verify.
\nStore should be passed the \"fileInfo\" object that was received when using Verify.
\nThe \"UID\" that is returned should be stored along with any other metadata. It is used to Download the file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","v2","files","store"],"host":["Store is used to commit a file that has been previously sent to the server using Verify.
\nStore should be passed the \"fileInfo\" object that was received when using Verify.
\nThe \"UID\" that is returned should be stored along with any other metadata. It is used to Download the file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","v2","files","store2"],"host":["Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"Shows the total number of records in the database - Warning this causes additional overhead
\n","type":"text/plain"},"key":"totalReq","value":"true"}],"variable":[]}},"response":[{"id":"a0dc3f61-5ca0-47c2-83c5-c8b548d7a7d2","name":"Single File","originalRequest":{"method":"POST","header":[{"key":"ETId","value":"17","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field"},{"key":"SV","value":"1","description":"The version of the data part of the envelope","disabled":true},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UID\": \"216f0683-c9cb-458d-9977-f4d4db3dd585\"\r\n}"},"url":{"raw":"The internal handling of files in V1.5 has changed from previous versions so it was decided to make a new API endpoint instead of implementing a breaking change.
\nStoring a file on The Platform is a 2 step process to reinforce the immutability of the action. Once you Store a file it cannot be deleted so extra care should be taken.
\nThe workflow for using the API is:
\nBe aware the Store endpoint returns a \"UID\" of the file upload and should be stored with other file metadata in order to quickly retrieve the file.
\n","_postman_id":"c785a6d8-3671-400b-ad56-495590feaaf3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}}],"id":"9b387387-b12f-40f0-bae7-745ce25515f4","description":"The Platform can handle binary files directly uploaded to it.\nEverything is encrypted and deduplication is done automatically.
\n","_postman_id":"9b387387-b12f-40f0-bae7-745ce25515f4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}},{"name":"Audit","item":[{"name":"Assisted Audit","item":[{"name":"Get Admin User","event":[{"listen":"test","script":{"id":"efdbdde3-36b3-4d2e-b04c-952263089ca7","exec":["pm.test(\"Validate Status Code\" , function()\r","{\r"," pm.response.to.have.status(200);\r"," console.log (\"Status is passed \");\r","})\r","\r","var responseBody = pm.response.json();\r","\r","var UID_response = responseBody.data[0].UID;\r","\r","pm.collectionVariables.set(\"UID_response\", JSON.stringify(UID_response));\r","\r","console.log(UID_response);"],"type":"text/javascript","packages":{}}}],"id":"5c9ab6e1-15cc-4039-9388-be216f0d75a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ETId","value":"10","description":"Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"UserName\": \"Admin\" }"},"url":"This get a user record to base the rest of the calls below on. In this case its the Admin user.
\nNotice how we are getting the record from the summart table.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","query","get"],"host":["Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field. For a getcomplex this is the primary table the query is based on.
\n"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"$match\": {\r\n \"UID\": \r\n }\r\n },\r\n {\r\n \"$sort\": {\r\n \"UpdatedAt\": 1\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"By using the history table, availiable for every ETId, is is possible to get a list of all updates to a particular data record by passing in the UID (Unique ID) for that data record.
\nPlease note, if the ETId is not marked as summary only the history table will exist and there will not be multiple records for a single UID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","query","getcomplex"],"host":["When a ETId, schema, is created with isSummary = true there are actually 2 tables that are created:
\nSummary:
\nThis is the typical table that contains 1 record for each item stored. I.E. 1 user based on UID or name.
\nThis is similar to a typical OLTP data table.
\nHistory:
\nData sharing in the Walcor platform is predicated on 2 Organizations are using a shared persistence layer.
An approval process has been built to ensure both parties are assured they are seeing the same version of the truth.
Used to check if the API is available for requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}},"urlObject":{"path":["api","health"],"host":["Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field
\n"},{"key":"SV","value":"1","type":"text","description":"The version of the data part of the envelope
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"The Envelope is the name for the standard way that all components of The Platform talk with each other. This enables code and processes to be shared/ reused across components.
\nFrom a technical standpoint, the envelope is a JSON object with a specific format that is used for the basis of all inter-process communication.
\n","_postman_id":"8d8530a1-63bf-44d0-8beb-a7bee55e6d72","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}}],"id":"11527d3e-8e9a-456d-af1f-edf67f25f16e","_postman_id":"11527d3e-8e9a-456d-af1f-edf67f25f16e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","id":"8c6292f0-f2d7-4f54-afb6-5918767216f9","name":"Walacor API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"12c07153-7513-407d-a510-bdcf006263c2","type":"text/javascript","exec":["const echoPostRequest = {"," url: pm.variables.replaceIn(\"