createSmartEntry

Adds a new SmartEntry into an existing SmartLibrary. If uploading a file or modifying thumbnail image then uploadSmartFile() or uploadTileImage() needs to be called.

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

POST /rest/smartlib/smartentry

Headers

Header	Required	Description
`x-nextinteract-authtoken`	Yes	Auth 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 (File) REQUEST Payload:

json

{
  "smartLibId" : 2,
  "smartEntryName" : "Test PPTX 1538011733656",
  "smartEntryDesc" : "Test PPTX Desc 1538011733656",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartFiles" : [ ],
  "smartEntryCategories" : [ ],
  "smartEntryAuthors" : "SAM Admin 1538011733656",
  "sendNotification" : true,
  "smartEntryURLs" : [ {
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagName" : "Tag1"
  }, {
    "smartTagName" : "Tag2"
  }, {
    "smartTagName" : "Tag3"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderName" : "AvailableFolder"
  }, {
    "smartFolderName" : "NotAvailableFolder"
  }, {
    "smartFolderId" : 5
  } ],
  "smartEntryFilters" : [ {
    "smartFilterName" : "AvailableFilter"
  }, {
    "smartFilterName" : "NotAvailableFilter"
  } ],
  "smartFileInfo" : {
    "originalFilename" : "event_image_1.jpg",
    "tempFilename" : "1538011733179-event_image_1.jpg",
    "tempImageName" : "1538011733179-event_image_1-tile.jpg"
  }
}

json

{
  "smartLibId" : 2,
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538013421974",
  "smartEntryDesc" : "URL Type Desc 1538013421974",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartFiles" : [ ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.com.au",
  "smartEntryAuthors" : "SAM Admin 1538013421974",
  "sendNotification" : true,
  "smartEntryURLs" : [ {
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagName" : "Tag1"
  }, {
    "smartTagName" : "Tag2"
  }, {
    "smartTagName" : "Tag3"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderName" : "AvailableFolder"
  }, {
    "smartFolderName" : "NotAvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterName" : "AvailableFilter"
  }, {
    "smartFilterName" : "NotAvailableFilter"
  } ]
}

json

{
  "smartLibId" : 2,
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538013966962",
  "smartEntryDesc" : "URL Type Desc 1538013966962",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartFiles" : [ ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.com.au",
  "smartEntryAuthors" : "SAM Admin 1538013966962",
  "smartEntryURLs" : [ {
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagName" : "Tag1"
  }, {
    "smartTagName" : "Tag2"
  }, {
    "smartTagName" : "Tag3"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderName" : "AvailableFolder"
  }, {
    "smartFolderName" : "NotAvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterName" : "AvailableFilter"
  }, {
    "smartFilterName" : "NotAvailableFilter"
  } ],
  "smartFileInfo" : {
    "tempImageName" : "1538013966915-event_image_2-tile.jpg"
  }
}

Response

200 OK

Normal Entry (FILE) RESPONSE

json

{
  "smartLibId" : 2,
  "smartEntryId" : 28,
  "smartEntryStatus" : "A",
  "smartEntryType" : "IMG",
  "smartEntryName" : "Test PPTX 1538011733656",
  "smartEntryDesc" : "Test PPTX Desc 1538011733656",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "notifyUserOfExternalUrl" : "N",
  "smartEntryCreated" : 1538011733727,
  "smartEntryModified" : 1538011733727,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartFiles" : [ {
    "smartEntryId" : 28,
    "smartFileId" : 56,
    "smartFileType" : "THMB",
    "smartFileName" : "event_image_1-b57f4821-f083-43b2-89c5-35b129e3885f-tile.jpg",
    "smartFileBytes" : 8647,
    "smartFileMd5" : "ede4cd20330c029414b090fae51b170c",
    "smartFileCreated" : 1538011733830,
    "smartFileModified" : 1538011733830
  }, {
    "smartEntryId" : 28,
    "smartFileId" : 55,
    "smartFileType" : "OUF",
    "smartFileName" : "event_image_1.jpg",
    "smartFileBytes" : 15295,
    "smartFileMd5" : "5484e9bd0fd640f835e84ca05d64d617",
    "smartFileCreated" : 1538011733812,
    "smartFileModified" : 1538011733812
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryAuthors" : "SAM Admin 1538011733656",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 79,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 80,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 81,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 2,
    "smartTagName" : "Tag2"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 5,
    "smartFolderName" : "KnownFolderById"
  }, {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}

json

{
  "smartLibId" : 2,
  "smartEntryId" : 31,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538013421974",
  "smartEntryDesc" : "URL Type Desc 1538013421974",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryCreated" : 1538013422071,
  "smartEntryModified" : 1538013422071,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartFiles" : [ {
    "smartEntryId" : 31,
    "smartFileId" : 61,
    "smartFileType" : "OUF",
    "smartFileName" : "index.html",
    "smartFileBytes" : 3311,
    "smartFileMd5" : "0ced21c9cb51224cfa63ba61034e5d9c",
    "smartFileCreated" : 1538013422675,
    "smartFileModified" : 1538013422675
  }, {
    "smartEntryId" : 31,
    "smartFileId" : 62,
    "smartFileType" : "THMB",
    "smartFileName" : "index-b826252e-1036-4c19-8718-71b9a4ffbd9c-tile.jpg",
    "smartFileBytes" : 13148,
    "smartFileMd5" : "e9e5a0894af678ca5ff9af221bcdb6b6",
    "smartFileCreated" : 1538013422736,
    "smartFileModified" : 1538013422736
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.com.au",
  "smartEntryAuthors" : "SAM Admin 1538013421974",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 88,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 90,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  }, {
    "smartEntryUrlId" : 89,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 2,
    "smartTagName" : "Tag2"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  }, {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}

json

{
  "smartLibId" : 2,
  "smartEntryId" : 33,
  "smartEntryStatus" : "A",
  "smartEntryType" : "URL",
  "smartEntryName" : "URL Type 1538013966962",
  "smartEntryDesc" : "URL Type Desc 1538013966962",
  "smartEntryDownloadOrig" : "N",
  "smartEntryDownloadPdf" : "N",
  "smartEntryCreated" : 1538013967013,
  "smartEntryModified" : 1538013967013,
  "smartEntryMetadataVersion" : 1,
  "smartEntryFileVersion" : 1,
  "smartFiles" : [ {
    "smartEntryId" : 33,
    "smartFileId" : 65,
    "smartFileType" : "OUF",
    "smartFileName" : "index.html",
    "smartFileBytes" : 3311,
    "smartFileMd5" : "0ced21c9cb51224cfa63ba61034e5d9c",
    "smartFileCreated" : 1538013967065,
    "smartFileModified" : 1538013967065
  }, {
    "smartEntryId" : 33,
    "smartFileId" : 66,
    "smartFileType" : "THMB",
    "smartFileName" : "index-d35b2039-7a51-4955-aa32-717e7b647e0d-tile.jpg",
    "smartFileBytes" : 9097,
    "smartFileMd5" : "8de862575bfb4e5ba97c21e3689821d6",
    "smartFileCreated" : 1538013967079,
    "smartFileModified" : 1538013967079
  } ],
  "smartEntryCategories" : [ ],
  "smartEntryUrlLink" : "https://www.google.com.au",
  "smartEntryAuthors" : "SAM Admin 1538013966962",
  "smartEntryURLs" : [ {
    "smartEntryUrlId" : 95,
    "smartEntryUrlName" : "MyURL1",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=1"
  }, {
    "smartEntryUrlId" : 94,
    "smartEntryUrlName" : "MyURL0",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=0"
  }, {
    "smartEntryUrlId" : 96,
    "smartEntryUrlName" : "MyURL2",
    "smartEntryUrlValue" : "http://myurl.com/myreference/paper?article=2"
  } ],
  "smartEntryTags" : [ {
    "smartTagId" : 3,
    "smartTagName" : "Tag3"
  }, {
    "smartTagId" : 1,
    "smartTagName" : "Tag1"
  }, {
    "smartTagId" : 2,
    "smartTagName" : "Tag2"
  } ],
  "smartEntryFolders" : [ {
    "smartFolderId" : 4,
    "smartFolderName" : "AvailableFolder"
  } ],
  "smartEntryFilters" : [ {
    "smartFilterId" : 2,
    "smartFilterName" : "AvailableFilter"
  } ]
}

Errors

Exception	Description
`WSInvalidParameterException`	See Error Definitions
`WSFieldLengthException`	See Error Definitions
`WSInvalidAuthTokenException`	See Error Definitions
`WSCacheServiceException`	See Error Definitions
`WSSmartLibNotFoundException`	See Error Definitions
`WSInsufficientPrivilegesException`	See Error Definitions
`WSUnsupportedTypeException`	See Error Definitions
`WSDuplicateSmartEntryException`	See Error Definitions
`WSDuplicateSmartFileException`	See Error Definitions
`WSAuthorisationServiceException`	See Error Definitions
`WSSmartLibraryServiceException`	See Error Definitions
`WSLimitExceededException`	See Error Definitions

createSmartEntry ​

Request ​

Headers ​

Parameters ​

Response ​

200 OK ​

Errors ​

createSmartEntry

Request

Headers

Parameters

Response

200 OK

Errors