Skip to content

updateSmartEntry ​

Updates an existing SmartEntry within a given SmartLibrary.

IMPORTANT NOTE: Currently (17-OCT-17) for all uploading and create/edit entries activities, the client needs to pass Cookies AWSELB and JSESSIONID in the request headers so that the load balancer directs you to the same server which files were uploaded to.

5-OCT-18 - added ability add URL type entries.

Request ​

http
PUT /rest/smartlib/smartentry

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

NOTE: -Tags and Filters need to be entered as text -Folders can be entered as text or Id (preferable for accuracy)

Normal Entry REQUEST:

json
{
  "smartLibId" : 2,
  "smartEntryId" : 64,
  "smartEntryStatus" : "A",
  "smartEntryType" : "IMG",
  "smartEntryName" : "Test PPTX 1538024215924 UPDATED.",
  "smartEntryDesc" : "Test PPTX Desc 1538024215924 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryModified" : 1538024215969,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartEntryCategories" : [ ],
  "smartEntryAuthors" : "SAM Admin 1538024215924 UPDATED.",
  "sendNotification" : true,
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 188,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 187,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 189,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  }, {
    "smartTagName" : "AdditionalTag"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}
json
{
  "smartLibId" : 2,
  "smartEntryId" : 65,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538024297601 UPDATED.",
  "smartEntryDesc" : "URL Type Desc 1538024297601 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryModified" : 1538024297662,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.it",
  "smartEntryAuthors" : "SAM Admin 1538024297601 UPDATED.",
  "sendNotification" : true,
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 191,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 190,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 192,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagName" : "AdditionalTag"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}
json
{
  "smartLibId" : 2,
  "smartEntryId" : 66,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538024401059 UPDATED.",
  "smartEntryDesc" : "URL Type Desc 1538024401059 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryModified" : 1538024401117,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.it",
  "smartEntryAuthors" : "SAM Admin 1538024401059 UPDATED.",
  "sendNotification" : true,
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 193,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 195,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  }, {
    "smartEntryUrlId" : 194,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagName" : "AdditionalTag"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ],
  "smartFileInfo" : {
    "tempImageName" : "1538024404076-event_image_2-tile.jpg"
  }
}

Response ​

200 OK ​

Normal Entry RESPONSE:

json
{
  "smartLibId" : 2,
  "smartEntryId" : 64,
  "smartEntryStatus" : "A",
  "smartEntryType" : "IMG",
  "smartEntryName" : "Test PPTX 1538024215924 UPDATED.",
  "smartEntryDesc" : "Test PPTX Desc 1538024215924 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "notifyUserOfExternalUrl" : "N",
  "smartEntryCreated" : 1538024215969,
  "smartEntryModified" : 1538024218009,
  "smartEntryMetadataVersion" : 2,
  "smartEntryFileVersion" : 1,
  "smartFiles" : [ {
    "smartEntryId" : 64,
    "smartFileId" : 137,
    "smartFileType" : "OUF",
    "smartFileName" : "event_image_1.jpg",
    "smartFileBytes" : 15295,
    "smartFileMd5" : "5484e9bd0fd640f835e84ca05d64d617",
    "smartFileCreated" : 1538024216013,
    "smartFileModified" : 1538024216013
  }, {
    "smartEntryId" : 64,
    "smartFileId" : 138,
    "smartFileType" : "THMB",
    "smartFileName" : "event_image_1-3d368e3f-d7fb-4e85-81e9-7d8cfc4427df-tile.jpg",
    "smartFileBytes" : 8647,
    "smartFileMd5" : "ede4cd20330c029414b090fae51b170c",
    "smartFileCreated" : 1538024216023,
    "smartFileModified" : 1538024216023
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryAuthors" : "SAM Admin 1538024215924 UPDATED.",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 189,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  }, {
    "smartEntryUrlId" : 188,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 187,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 5,
    "smartTagName" : "AdditionalTag"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}
json
{
  "smartLibId" : 2,
  "smartEntryId" : 65,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538024297601 UPDATED.",
  "smartEntryDesc" : "URL Type Desc 1538024297601 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryCreated" : 1538024297662,
  "smartEntryModified" : 1538024300683,
  "smartEntryMetadataVersion" : 2,
  "smartEntryFileVersion" : 2,
  "smartFiles" : [ {
    "smartEntryId" : 65,
    "smartFileId" : 141,
    "smartFileType" : "OUF",
    "smartFileName" : "index.html",
    "smartFileBytes" : 3303,
    "smartFileMd5" : "096374f0de640f4d58dde083d7464a80",
    "smartFileCreated" : 1538024300699,
    "smartFileModified" : 1538024300699
  }, {
    "smartEntryId" : 65,
    "smartFileId" : 140,
    "smartFileType" : "THMB",
    "smartFileName" : "index-143ba367-9d94-4108-860f-3230e45f03b6-tile.jpg",
    "smartFileBytes" : 13148,
    "smartFileMd5" : "e9e5a0894af678ca5ff9af221bcdb6b6",
    "smartFileCreated" : 1538024297959,
    "smartFileModified" : 1538024297959
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.it",
  "smartEntryAuthors" : "SAM Admin 1538024297601 UPDATED.",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 191,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 192,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  }, {
    "smartEntryUrlId" : 190,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 5,
    "smartTagName" : "AdditionalTag"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}
json
{
  "smartLibId" : 2,
  "smartEntryId" : 66,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538024401059 UPDATED.",
  "smartEntryDesc" : "URL Type Desc 1538024401059 UPDATED.",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryCreated" : 1538024401117,
  "smartEntryModified" : 1538024404115,
  "smartEntryMetadataVersion" : 2,
  "smartEntryFileVersion" : 2,
  "smartFiles" : [ {
    "smartEntryId" : 66,
    "smartFileId" : 144,
    "smartFileType" : "OUF",
    "smartFileName" : "index.html",
    "smartFileBytes" : 3303,
    "smartFileMd5" : "096374f0de640f4d58dde083d7464a80",
    "smartFileCreated" : 1538024404287,
    "smartFileModified" : 1538024404287
  }, {
    "smartEntryId" : 66,
    "smartFileId" : 146,
    "smartFileType" : "THMB",
    "smartFileName" : "index-tile.jpg",
    "smartFileBytes" : 9097,
    "smartFileMd5" : "8de862575bfb4e5ba97c21e3689821d6",
    "smartFileCreated" : 1538024405480,
    "smartFileModified" : 1538024405480
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.it",
  "smartEntryAuthors" : "SAM Admin 1538024401059 UPDATED.",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 194,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 193,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 195,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 5,
    "smartTagName" : "AdditionalTag"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSFieldLengthExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInsufficientPrivilegesExceptionSee Error Definitions
WSSmartEntryNotFoundExceptionSee Error Definitions
WSSmartLibNotFoundExceptionSee Error Definitions
WSUnsupportedTypeExceptionSee Error Definitions
WSDuplicateSmartEntryExceptionSee Error Definitions
WSDuplicateSmartFileExceptionSee Error Definitions
WSAuthorisationServiceExceptionSee Error Definitions
WSSmartLibraryServiceExceptionSee Error Definitions
WSLimitExceededExceptionSee Error Definitions