axiom-apis
v1.0.1
Published
This node module contains wrapper mathods to call Axiom APIs
Downloads
3
Readme
axiom-apis
Axiom-apis module.
Usage:
var axiom = require('axiom-apis')();
See: www.npmjs.com/package/axiom-apis
- axiom-apis
- ~AxiomAPIs : Object
- .URL : String
- .UserID : String
- .access_token : String
- .listProjects(cb)
- .listPublicProjects(isMarket, cb)
- .listProjectMembers(projectID, cb)
- .getTagListByElement(elementTypeID, projectID, cb)
- .saveProject(name, desc, projectid, URL, invitedStr, Comment, tagStr, Photo, Overview, companyName, department, productName, isOverviewActive, isCollaVisible, isMemberVisible, isDefaultColla, fixTags, isOtherTagNotAllowed, isOverviewUpdate, cb)
- .getOverviewContent(projectID, cb)
- .getProjectDetailsByProjectID(projectID, cb)
- .deleteProject(projectID, cb)
- .inviteMember(projectid, invitedStr, cb)
- .getCollaboratorList(projectID, isMarket, cb)
- .removeCollaborators(email, projectid, cb)
- .changeOwner(projectid, ProjectOwnerID, cb)
- .getCollaboratorProfile(projectID, collaID, cb)
- .getDetailForPublish(projectID, cb)
- .publishProject(categoryID, subcategoryID, projectID, cb)
- .getRecentUpdates(projectID, cb)
- .getFileListByProjectID(projectID, isMarket, cb)
- .getUploadExtentions(cb)
- .resendSignupmail(email, captchaAns, cb)
- .getAllTask(projectID, isMarket, cb)
- .createTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
- .updateTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
- .getTaskDetailsByID(taskID, projectID, isMarket, cb)
- .getPostHistory(taskID, cb)
- .updateTaskStatus(name, taskID, URL, status, cb)
- .saveComment(taskID, latitude, longitude, comment, URL, fileInfo, cb)
- .deleteComment(commentID, isComment, fileName, cb)
- .updateprofile(firstname, lastname, email, password, oldEmailID, timezoneid, actualfilename, URL, cb)
- .updatepassword(newPassword, oldPassword, cb)
- .deleteFile(fileName, cb)
- .getNotificationByUser(userID, cb)
- .getNotificationList(userID, weekNo, cb)
- .listTables(projectID, isMarket, cb)
- .getTableDetails(viewID, includeTempTable, where, cb)
- .getTableData(viewID, from, to, tableName, where, commonAPITableName, considerTopXWhenDrop, canViewOnlySelfRows, cb)
- .getTableFilters(viewID, filterID, cb)
- .isTableLocked(tableID, viewID, cb)
- .deleteTableFilters(filterIDs, cb)
- .saveTableFilters(viewID, filterID, filterName, filterDetails, isAlert, cb)
- .setTableFilterAsDefault(viewID, filterID, isDefault, cb)
- .applyTableFilters(viewID, filterID, showTopXRows, tn, filtersData, cb)
- .getUserRightsForPublish(parentViewID, viewID, mode, filterID, projectID, cb)
- .removeTable(viewIDs, isArchive, cb)
- .getLookupKeyColumns(viewID, projectID, cb)
- .getLookupTableStructure(tableID, projectID, VDID, cb)
- .getLookupValues(IDs, cb)
- .getCellHistory(rowID, VDID, cb)
- ~AxiomAPIs : Object
axiom-apis~AxiomAPIs : Object
AxiomAPIs is wrapper library to call axiom APIs.
Kind: inner property of axiom-apis
- ~AxiomAPIs : Object
- .URL : String
- .UserID : String
- .access_token : String
- .listProjects(cb)
- .listPublicProjects(isMarket, cb)
- .listProjectMembers(projectID, cb)
- .getTagListByElement(elementTypeID, projectID, cb)
- .saveProject(name, desc, projectid, URL, invitedStr, Comment, tagStr, Photo, Overview, companyName, department, productName, isOverviewActive, isCollaVisible, isMemberVisible, isDefaultColla, fixTags, isOtherTagNotAllowed, isOverviewUpdate, cb)
- .getOverviewContent(projectID, cb)
- .getProjectDetailsByProjectID(projectID, cb)
- .deleteProject(projectID, cb)
- .inviteMember(projectid, invitedStr, cb)
- .getCollaboratorList(projectID, isMarket, cb)
- .removeCollaborators(email, projectid, cb)
- .changeOwner(projectid, ProjectOwnerID, cb)
- .getCollaboratorProfile(projectID, collaID, cb)
- .getDetailForPublish(projectID, cb)
- .publishProject(categoryID, subcategoryID, projectID, cb)
- .getRecentUpdates(projectID, cb)
- .getFileListByProjectID(projectID, isMarket, cb)
- .getUploadExtentions(cb)
- .resendSignupmail(email, captchaAns, cb)
- .getAllTask(projectID, isMarket, cb)
- .createTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
- .updateTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
- .getTaskDetailsByID(taskID, projectID, isMarket, cb)
- .getPostHistory(taskID, cb)
- .updateTaskStatus(name, taskID, URL, status, cb)
- .saveComment(taskID, latitude, longitude, comment, URL, fileInfo, cb)
- .deleteComment(commentID, isComment, fileName, cb)
- .updateprofile(firstname, lastname, email, password, oldEmailID, timezoneid, actualfilename, URL, cb)
- .updatepassword(newPassword, oldPassword, cb)
- .deleteFile(fileName, cb)
- .getNotificationByUser(userID, cb)
- .getNotificationList(userID, weekNo, cb)
- .listTables(projectID, isMarket, cb)
- .getTableDetails(viewID, includeTempTable, where, cb)
- .getTableData(viewID, from, to, tableName, where, commonAPITableName, considerTopXWhenDrop, canViewOnlySelfRows, cb)
- .getTableFilters(viewID, filterID, cb)
- .isTableLocked(tableID, viewID, cb)
- .deleteTableFilters(filterIDs, cb)
- .saveTableFilters(viewID, filterID, filterName, filterDetails, isAlert, cb)
- .setTableFilterAsDefault(viewID, filterID, isDefault, cb)
- .applyTableFilters(viewID, filterID, showTopXRows, tn, filtersData, cb)
- .getUserRightsForPublish(parentViewID, viewID, mode, filterID, projectID, cb)
- .removeTable(viewIDs, isArchive, cb)
- .getLookupKeyColumns(viewID, projectID, cb)
- .getLookupTableStructure(tableID, projectID, VDID, cb)
- .getLookupValues(IDs, cb)
- .getCellHistory(rowID, VDID, cb)
AxiomAPIs.URL : String
url on which all axiom apis will be called
Kind: static property of AxiomAPIs
AxiomAPIs.UserID : String
axiom user id will be stored in this variable
Kind: static property of AxiomAPIs
AxiomAPIs.access_token : String
access_token provided by axiom will be stored in this variable and then will be used in all other API calls automatically
Kind: static property of AxiomAPIs
AxiomAPIs.listProjects(cb)
This all the projects for the current user. It includes the the projects associated to the user as well as the public projects
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | cb | function | This is the Callback method tobe called after the listProjects is executed |
AxiomAPIs.listPublicProjects(isMarket, cb)
This all the public projects for the current user.
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | isMarket | Boolean | If one wants to recieve all public projects this field should be specified to 2 | | cb | function | This is the Callback method tobe called after the listPublicProjects is executed |
AxiomAPIs.listProjectMembers(projectID, cb)
To list all the members of a prjoect given the project ID
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | number | Project's ID | | cb | function | This is the Callback method tobe called after the listProjectMembers is executed |
AxiomAPIs.getTagListByElement(elementTypeID, projectID, cb)
Get a list of all tags of the given element (i.e. tags assigned to table,task,file etc) assigned to a project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | elementTypeID | number | Type Id agaisnt the element type chosen | | projectID | number | project ID | | cb | function | This is the Callback method tobe called after the getTagListByElement is executed |
AxiomAPIs.saveProject(name, desc, projectid, URL, invitedStr, Comment, tagStr, Photo, Overview, companyName, department, productName, isOverviewActive, isCollaVisible, isMemberVisible, isDefaultColla, fixTags, isOtherTagNotAllowed, isOverviewUpdate, cb)
To add a new project or to update the details of an existing one
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | name | String | Project name | | desc | String | Description of the project | | projectid | number | 0 if new project | | URL | String | BaseURL | | invitedStr | String | List of comma separated emailIDs of invited members | | Comment | String | Commment Text if added | | tagStr | String | List of comma separated tags | | Photo | String | file name for uploaded project image | | Overview | String | Overview of the project | | companyName | String | Company initiating the project | | department | String | The department under which the project falls | | productName | String | Product on which the prjoect is based | | isOverviewActive | Boolean | To activate the 'overview' section | | isCollaVisible | Boolean | 1 to hide other collaborators | | isMemberVisible | Boolean | 1 to hide other members | | isDefaultColla | Boolean | 1 to make creator default collaborator | | fixTags | String | set tags | | isOtherTagNotAllowed | Boolean | 1 if the word 'other' cannot be a tag | | isOverviewUpdate | Boolean | If an exisiting project is updated and the value of the 'overview' key is changed this variable is to be set to 1 | | cb | function | This is the Callback method tobe called after the saveProject is executed |
AxiomAPIs.getOverviewContent(projectID, cb)
Get the value of the key 'overview' of a project given the project ID
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | number | Project ID | | cb | function | This is the Callback method tobe called after the getOverviewContent is executed |
AxiomAPIs.getProjectDetailsByProjectID(projectID, cb)
Get all the information saved under a project given the projectID
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | number | | | cb | function | This is the Callback method tobe called after the getProjectDetailsByProjectID is executed |
AxiomAPIs.deleteProject(projectID, cb)
Delete a project given the projectID
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | number | | | cb | function | This is the Callback method tobe called after the deleteProject is executed |
AxiomAPIs.inviteMember(projectid, invitedStr, cb)
Add collaborators to a given project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectid | number | | | invitedStr | String | List of comma separated emailIDs of invited members | | cb | function | This is the Callback method tobe called after the inviteMember is executed |
AxiomAPIs.getCollaboratorList(projectID, isMarket, cb)
Get a list of all collaborators of a given project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | number | | | isMarket | Boolean | | | cb | function | This is the Callback method tobe called after the getCollaboratorList is executed |
AxiomAPIs.removeCollaborators(email, projectid, cb)
To remove an exisiting collaborator from the given project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | email | String | Registered email of the collaborator who is to be removed | | projectid | number | | | cb | function | This is the Callback method to be called after the removeCollaborators is executed |
AxiomAPIs.changeOwner(projectid, ProjectOwnerID, cb)
This method facilitates the tranfer of ownership from one user to another
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectid | Number | new owner's userID | | ProjectOwnerID | Number | original owner's userID | | cb | function | This is the Callback method to be called after the changeOwner is executed |
AxiomAPIs.getCollaboratorProfile(projectID, collaID, cb)
Get user details of a collaborator of the given project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | | | collaID | Number | userID of collaborator | | cb | function | This is the Callback method to be called after the getCollaboratorProfile is executed |
AxiomAPIs.getDetailForPublish(projectID, cb)
To get information about the given project berfore publishing
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | | | cb | function | This is the Callback method to be called after the getDetailForPublish is executed |
AxiomAPIs.publishProject(categoryID, subcategoryID, projectID, cb)
[publishProject description]
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | categoryID | Number | CategoryID under which the project is to be published | | subcategoryID | Number | subcategoryID of the chosen category | | projectID | Number | | | cb | function | This is the Callback method to be called after the publishProject is executed |
AxiomAPIs.getRecentUpdates(projectID, cb)
Get the activity on a given project of the current user during their most recent login
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | | | cb | function | This is the Callback method to be called after the getRecentUpdates is executed |
AxiomAPIs.getFileListByProjectID(projectID, isMarket, cb)
Get a list of all media/files added under a project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | | | isMarket | Boolean | project type | | cb | function | This is the Callback method to be called after the getFileListByProjectID is executed |
AxiomAPIs.getUploadExtentions(cb)
Get a list of permitted extention names of the files to be uploaded
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | cb | function | This is the Callback method to be called after the getUploadExtentions is executed |
AxiomAPIs.resendSignupmail(email, captchaAns, cb)
resendSignupmail takes takes the email address of a newly registered user and sends them an email confirmation.
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | email | String | Email address to which the signup mail is sent | | captchaAns | String | captha code | | cb | function | This is the Callback method to be called after the resendSignupmail is executed |
AxiomAPIs.getAllTask(projectID, isMarket, cb)
Get all the tasks created by a user under the given project
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | | | isMarket | Boolean | | | cb | function | This is the Callback method to be called after the getAllTask is executed |
AxiomAPIs.createTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
This helps add new tasks to a project or update exisiting ones given the project id
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | taskID | Number | | | taskName | String | Title for the task | | desc | String | Description | | projectID | Number | Container project | | assignTo | Number | ID of the user the task is assigned to be completed | | URL | String | baseURL | | latitude | Number | | | longitude | Number | | | strCCUserID | String | string of comma seperated IDs of the users to be CCed | | isPublicdueDate | Boolean | 1 if due date is to be displayed publically | | actualDueDate | Number | date of entry | | tagStr | String | string of comma seperated tags to be linked to the task | | fileInfo | Array | Array of file details | | deleteFileList | Array | Array of files names to be removed | | allFiles | Array | Array of all filesname | | cb | function | This is the Callback method to be called after the createTask is executed |
AxiomAPIs.updateTask(taskID, taskName, desc, projectID, assignTo, URL, latitude, longitude, strCCUserID, isPublicdueDate, actualDueDate, tagStr, fileInfo, deleteFileList, allFiles, cb)
This helps add new tasks to a project or update exisiting ones given the project id
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | taskID | Number | 0 if updating existing task | | taskName | String | Title for the task | | desc | String | Description | | projectID | Number | Container project | | assignTo | Number | ID of the user the task is assigned to be completed | | URL | String | baseURL | | latitude | Number | | | longitude | Number | | | strCCUserID | String | string of comma seperated IDs of the users to be CCed | | isPublicdueDate | Boolean | 1 if due date is to be displayed publically | | actualDueDate | Number | date of entry | | tagStr | String | string of comma seperated tags to be linked to the task | | fileInfo | Array | Array of file details | | deleteFileList | Array | Array of files names to be removed | | allFiles | Array | Array of all filesname | | cb | function | This is the Callback method to be called after the createTask is executed |
AxiomAPIs.getTaskDetailsByID(taskID, projectID, isMarket, cb)
Get information about a task given the task ID
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | taskID | Number | | projectID | Number | | isMarket | Boolean | | cb | function |
AxiomAPIs.getPostHistory(taskID, cb)
Get activity logs of the given task of the current user
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | taskID | Number | | cb | function |
AxiomAPIs.updateTaskStatus(name, taskID, URL, status, cb)
This API facilitates the staus update on a task
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | name | String | asignee name ? | | taskID | Number | | | URL | String | Base URL | | status | Number | The value to which the status is to be updated | | cb | function | |
AxiomAPIs.saveComment(taskID, latitude, longitude, comment, URL, fileInfo, cb)
saveComment posts a comment under the given task
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | taskID | Number | Task ID | | latitude | Number | Geocoordinates of the current user | | longitude | Number | Geocoordinates of the current user | | comment | String | Comment text to be posted | | URL | String | Base url | | fileInfo | Array | Array of file names uploaded with the comment | | cb | function | Callback method |
AxiomAPIs.deleteComment(commentID, isComment, fileName, cb)
This API deletes a comment given the comment ID
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | commentID | Number | Comment ID | | isComment | Boolean | If the comment has text | | fileName | String | file name of attachment with the comment | | cb | function | Callback method |
AxiomAPIs.updateprofile(firstname, lastname, email, password, oldEmailID, timezoneid, actualfilename, URL, cb)
Updates user's personal info
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | firstname | String | User's first name | | lastname | String | User's last name | | email | String | User's current registered email ID | | password | String | User's password | | oldEmailID | String | New emailID, if the email is to be updated | | timezoneid | Number | timezone of the user | | actualfilename | String | file name of the user's profile picture | | URL | String | Base URL (to the uploaded files) | | cb | function | Callback method |
AxiomAPIs.updatepassword(newPassword, oldPassword, cb)
This API is used to change the password for the current user
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | newPassword | String | | oldPassword | String | | cb | function |
AxiomAPIs.deleteFile(fileName, cb)
Delete an ploaded file
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | fileName | String | | cb | function |
AxiomAPIs.getNotificationByUser(userID, cb)
Returns a list of activity of the given user
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | userID | Number | | cb | function |
AxiomAPIs.getNotificationList(userID, weekNo, cb)
Get all the activitties of a user over the week
Kind: static method of AxiomAPIs
| Param | Type | | --- | --- | | userID | Number | | weekNo | Number | | cb | function |
AxiomAPIs.listTables(projectID, isMarket, cb)
List all the tables added to a project by the current user
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | projectID | Number | Project ID | | isMarket | Number | 1 if project is public | | cb | function | Callback method |
AxiomAPIs.getTableDetails(viewID, includeTempTable, where, cb)
[getTableDetails description]
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | view ID | | includeTempTable | Number | If 1 put data in a temporary table | | where | String | Conditions if any on the data to retrieved | | cb | function | Callback method |
AxiomAPIs.getTableData(viewID, from, to, tableName, where, commonAPITableName, considerTopXWhenDrop, canViewOnlySelfRows, cb)
This API fetches all the data from a given table
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | View ID | | from | Number | From cell number | | to | Number | To cell number | | tableName | String | table Name | | where | String | conditions if to filter the data to be recieved | | commonAPITableName | String | Temporay name for the data between from and to | | considerTopXWhenDrop | Number | Return only X rows from the top if thi key is set 1 | | canViewOnlySelfRows | Number | 1 if only the rows assgined to the current user must be returned | | cb | function | Callback method |
AxiomAPIs.getTableFilters(viewID, filterID, cb)
Get preexisting filters
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | ViewId of the view seen by the user | | filterID | Number | filterID of the filter to be retrieved | | cb | function | Callback Method |
AxiomAPIs.isTableLocked(tableID, viewID, cb)
For a given user and their view on a table, it returns if the table is locked. (i.e. not editable by the user)
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | tableID | Number | Table Id of the given table | | viewID | Number | View Id of the given view | | cb | function | Callback method |
AxiomAPIs.deleteTableFilters(filterIDs, cb)
Delete filters that were applied on a table
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | filterIDs | String | Strimg of comma separated filterIDs | | cb | function | Callback method |
AxiomAPIs.saveTableFilters(viewID, filterID, filterName, filterDetails, isAlert, cb)
Add a new filter to the table
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | ViewID | | filterID | Number | ID against the name of the filter to be applied | | filterName | String | filter's name | | filterDetails | String | String of values to which filter is applied | | isAlert | Number | If 1, when the table updates, checks if any filter becomes applicable and if yes sends an email to collaborators about the change | | cb | function | Callback method |
AxiomAPIs.setTableFilterAsDefault(viewID, filterID, isDefault, cb)
This API sets the given filter as a deafult on the given table
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | ViewID | | filterID | Number | ID against the name of the filter to be applied | | isDefault | Boolean | Set to 1 to have the filter be applied to the table by default | | cb | function | Callback method |
AxiomAPIs.applyTableFilters(viewID, filterID, showTopXRows, tn, filtersData, cb)
Applies dynamic filters to a table
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | ViewID | | filterID | Number | ID against the name of the filter to be applied | | showTopXRows | Number | Number of rows from the top to be displayed | | tn | String | Table name | | filtersData | Object | Stringified object having an array of the length equal to the number of columns to which the filter is applied. Each element in the array has filterName the cell numbers to be applies and the conditions on which it should be applied | | cb | function | Callback method |
AxiomAPIs.getUserRightsForPublish(parentViewID, viewID, mode, filterID, projectID, cb)
Gets user's rights(permissions) for a table that the user wants to publish
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | parentViewID | Number | The ID of the view underwhich the table was created | | viewID | Number | View ID of the table | | mode | String | | | filterID | Number | The Filter on the table | | projectID | Number | The project under which the table was created | | cb | function | Callback method |
AxiomAPIs.removeTable(viewIDs, isArchive, cb)
To delete a table from the view
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewIDs | String | String of comma separated ViewIDs | | isArchive | Boolean | If 1 archive/hide instead of delete | | cb | function | Callback method |
AxiomAPIs.getLookupKeyColumns(viewID, projectID, cb)
Given a table and viewID, get the permitted fields (to the current user) to do a lookup on
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | viewID | Number | ID of the view | | projectID | Number | ID of the projectID | | cb | function | Callback method |
AxiomAPIs.getLookupTableStructure(tableID, projectID, VDID, cb)
Gets the table structure of the lookup for a given project of a given view for the current user
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | tableID | Number | table ID | | projectID | Number | Project ID | | VDID | Number | view details ID | | cb | function | Callback method |
AxiomAPIs.getLookupValues(IDs, cb)
Get the lookup values given the viewDetailsIDs
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | IDs | String | String of comma separated viewDetailsIDs | | cb | function | Callback Function |
AxiomAPIs.getCellHistory(rowID, VDID, cb)
Get the change in call values over time given the rowID and viewID for the current user
Kind: static method of AxiomAPIs
| Param | Type | Description | | --- | --- | --- | | rowID | Number | rowID | | VDID | Number | viewDetailsID | | cb | function | Callback method |