findSmartEntriesForSmartLibrary

Returns a SmartEntry with child SmartEntries including metadata for SmartLib (Tags, Filters, Folders) and metadata and children objects for SmartEntries. Supports paging with pageSize configured in SAM at 50 entries per page. Response payload is GZIPPED to optimise network size

Request

http

GET /rest/smartlib/{smartLibId}

Headers

Header	Required	Description
`x-nextinteract-authtoken`	Yes	Auth token returned from loginUser

Parameters

Parameter	Type	Required	Description
`smartLibId`	Long	Yes	Path parameter of smartLib Id that user is requesting entries for
`includeAll`	Boolean	No	Flag to indicate that ALL data should be fetched as in a "deep fetch" otherwise only thumbnails are returned
`pageNum`	Integer	No	Integer value to control paging. Starts at 1. NOTE: response contains `totalActivePages` and `totalActiveSmartEntries` which can be used by clients to determine paging functionality
`searchWords`	String	No	Multiple search words to a maximum of ten. Easiest usage is to repeat the query param as in `searchWords=Foo%20Bar&searchWords=Bar` etc etc. Search looks for all search words in either Title OR Description OR Tags.
`viewBy`	String	No	Controls which field(s) to order by. Supported values [`lastModified`, `entryName`]. Defaults to `lastModified`.
`orderBy`	String	No	Controls the order of entries returned to client. Supported values [`asc`, `desc`]. Intended mainly for use by MI Desktop. If no value provides defaults to `desc`
`smartFolderId`	Long	No	To show entries under a specified folder for SmartLibraries that have Folders enabled (TP#11279)
`hideContainerInfo`	Boolean	No	Default NO. To hide the container info and just return entries
`version`	Integer	No	Defaults to version 1 when not supplied. When `version=1` then order defaults to "Last Modified Descending" and all entries returned with no folders. When `version=2` when searching entries by keyword we won’t return any folders in the payload. When `version=2` and `smartFolderId=null` then default top level folder. When `version=2` and `smartFolderId` supplied then folders/entries returned in order specified by smart library setting

Response

200 OK

WHEN hideContainerInfo is omitted (or false) THEN payload like below:

json

{
  "smartLibOrder": "AO",
  "urlTemplate": "standard-entry-url.html",
  "authorIsUploader": "N",
  "userRoles": [
    "PUBLISHER",
    "UPLOADER"
  ],
  "smartLibId": 347,
  "smartLibOwner": "CO",
  "cId": 3,
  "cName": "My Interact Finance",
  "targetAppCode": "MY",
  "smartLibStatus": "A",
  "smartLibName": "Test Library",
  "smartLibDesc": "My test library",
  "smartLibVersion": 9,
  "smartLibRequiresMetadata": "Y",
  "smartLibCreated": 1537937973380,
  "smartLibCreatedBy": "1",
  "smartLibModified": 1537937973380,
  "smartLibModifiedBy": "1",
  "smartLibUsesFolders": "N",
  "smartLibUsesFilters": "Y",
  "defaultUserRole": "RA",
  "smartEntries": [
    {
      "smartLibId": 347,
      "smartEntryId": 454,
      "smartEntryStatus": "A",
      "smartEntryType": "PDF",
      "smartEntryName": "AWS HIPAA Whitepaper Final",
      "smartEntryDesc": "AWS HIPAA Whitepaper Final",
      "smartEntryDownloadOrig": "N",
      "smartEntryDownloadPdf": "N",
      "smartEntryCreated": 1537938167057,
      "smartEntryModified": 1537938211113,
      "smartEntryMetadataVersion": 2,
      "smartEntryFileVersion": 1,
      "smartEntryRelatedDate": 1537315200000,
      "smartFiles": [
        {
          "smartEntryId": 454,
          "smartFileId": 565,
          "smartFileType": "THMB",
          "smartFileName": "AWS_HIPAA_Whitepaper_Final-5657a665-c0cb-4d15-866f-9a00ed55d961-tile.jpg",
          "smartFileBytes": 24246,
          "smartFileMd5": "3adf0dce2b7f25a7f33041b692cccf3b",
          "smartFileCreated": 1537938167210,
          "smartFileModified": 1537938167210,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/454/files/565/AWS_HIPAA_Whitepaper_Final-5657a665-c0cb-4d15-866f-9a00ed55d961-tile.jpg"
        },
        {
          "smartEntryId": 454,
          "smartFileId": 564,
          "smartFileType": "OUF",
          "smartFileName": "AWS_HIPAA_Whitepaper_Final.pdf",
          "smartFileBytes": 128304,
          "smartFileMd5": "42af94dd0a50c844acc50e66d6094c20",
          "smartFileCreated": 1537938167092,
          "smartFileModified": 1537938167092,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/454/files/564/AWS_HIPAA_Whitepaper_Final.pdf"
        }
      ],
      "smartEntryCategories": [],
      "smartEntryAuthors": "Aaron, HIPAA",
      "smartEntryURLs": [
        {
          "smartEntryUrlId": 4,
          "smartEntryUrlName": "Interact Technology",
          "smartEntryUrlValue": "http://www.interact.technology"
        }
      ],
      "smartEntryTags": [
        {
          "smartTagId": 109,
          "smartTagName": "Tag2"
        }
      ],
      "smartEntryFolders": [],
      "smartEntryFilters": [
        {
          "smartFilterId": 22,
          "smartFilterName": "Filter2"
        }
      ]
    },
    {
      "smartLibId": 347,
      "smartEntryId": 453,
      "smartEntryStatus": "A",
      "smartEntryType": "URL",
      "smartEntryName": "Google.com",
      "smartEntryDesc": "Google.com website",
      "smartEntryDownloadOrig": "N",
      "smartEntryDownloadPdf": "N",
      "smartEntryCreated": 1537938036977,
      "smartEntryModified": 1537938036977,
      "smartEntryMetadataVersion": 1,
      "smartEntryFileVersion": 1,
      "smartEntryRelatedDate": 1536105600000,
      "smartFiles": [
        {
          "smartEntryId": 453,
          "smartFileId": 562,
          "smartFileType": "OUF",
          "smartFileName": "index.html",
          "smartFileBytes": 3297,
          "smartFileMd5": "caa3aab46945ac50eef4a2bd2e147b70",
          "smartFileCreated": 1537938037093,
          "smartFileModified": 1537938037093,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/453/files/562/index.html"
        },
        {
          "smartEntryId": 453,
          "smartFileId": 563,
          "smartFileType": "THMB",
          "smartFileName": "index-88fa2fc1-fc80-4799-9863-4e6a9b1e4e34-tile.jpg",
          "smartFileBytes": 13148,
          "smartFileMd5": "e9e5a0894af678ca5ff9af221bcdb6b6",
          "smartFileCreated": 1537938037149,
          "smartFileModified": 1537938037149,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/453/files/563/index-88fa2fc1-fc80-4799-9863-4e6a9b1e4e34-tile.jpg"
        }
      ],
      "smartEntryCategories": [],
      "smartEntryUrlLink": "https://google.com",
      "smartEntryAuthors": "Aaron, Peter, Archana",
      "smartEntryURLs": [],
      "smartEntryTags": [
        {
          "smartTagId": 108,
          "smartTagName": "Tag1"
        }
      ],
      "smartEntryFolders": [],
      "smartEntryFilters": [
        {
          "smartFilterId": 21,
          "smartFilterName": "Filter1"
        }
      ]
    }
  ],
  "smartLibTags": [
    {
      "smartTagId": 110,
      "smartTagName": "Tag3"
    },
    {
      "smartTagId": 108,
      "smartTagName": "Tag1"
    },
    {
      "smartTagId": 109,
      "smartTagName": "Tag2"
    }
  ],
  "smartLibFolders": [],
  "smartLibFilters": [
    {
      "smartFilterId": 21,
      "smartFilterName": "Filter1"
    },
    {
      "smartFilterId": 22,
      "smartFilterName": "Filter2"
    }
  ],
  "totalActiveSmartEntries": 2,
  "totalRecords": 2,
  "totalActivePages": 1,
  "userCanUpload": true
}

json

{
  "smartLibOrder": "AO",
  "userRoles": [],
  "smartLibUsesFolders": "N",
  "smartEntries": [
    {
      "smartLibId": 347,
      "smartEntryId": 454,
      "smartEntryStatus": "A",
      "smartEntryType": "PDF",
      "smartEntryName": "AWS HIPAA Whitepaper Final",
      "smartEntryDesc": "AWS HIPAA Whitepaper Final",
      "smartEntryDownloadOrig": "N",
      "smartEntryDownloadPdf": "N",
      "smartEntryCreated": 1537938167057,
      "smartEntryModified": 1537938211113,
      "smartEntryMetadataVersion": 2,
      "smartEntryFileVersion": 1,
      "smartEntryRelatedDate": 1537315200000,
      "smartFiles": [
        {
          "smartEntryId": 454,
          "smartFileId": 565,
          "smartFileType": "THMB",
          "smartFileName": "AWS_HIPAA_Whitepaper_Final-5657a665-c0cb-4d15-866f-9a00ed55d961-tile.jpg",
          "smartFileBytes": 24246,
          "smartFileMd5": "3adf0dce2b7f25a7f33041b692cccf3b",
          "smartFileCreated": 1537938167210,
          "smartFileModified": 1537938167210,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/454/files/565/AWS_HIPAA_Whitepaper_Final-5657a665-c0cb-4d15-866f-9a00ed55d961-tile.jpg"
        },
        {
          "smartEntryId": 454,
          "smartFileId": 564,
          "smartFileType": "OUF",
          "smartFileName": "AWS_HIPAA_Whitepaper_Final.pdf",
          "smartFileBytes": 128304,
          "smartFileMd5": "42af94dd0a50c844acc50e66d6094c20",
          "smartFileCreated": 1537938167092,
          "smartFileModified": 1537938167092,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/454/files/564/AWS_HIPAA_Whitepaper_Final.pdf"
        }
      ],
      "smartEntryCategories": [],
      "smartEntryAuthors": "Aaron, HIPAA",
      "smartEntryURLs": [
        {
          "smartEntryUrlId": 4,
          "smartEntryUrlName": "Interact Technology",
          "smartEntryUrlValue": "http://www.interact.technology"
        }
      ],
      "smartEntryTags": [
        {
          "smartTagId": 109,
          "smartTagName": "Tag2"
        }
      ],
      "smartEntryFolders": [],
      "smartEntryFilters": [
        {
          "smartFilterId": 22,
          "smartFilterName": "Filter2"
        }
      ]
    },
    {
      "smartLibId": 347,
      "smartEntryId": 453,
      "smartEntryStatus": "A",
      "smartEntryType": "URL",
      "smartEntryName": "Google.com",
      "smartEntryDesc": "Google.com website",
      "smartEntryDownloadOrig": "N",
      "smartEntryDownloadPdf": "N",
      "smartEntryCreated": 1537938036977,
      "smartEntryModified": 1537938036977,
      "smartEntryMetadataVersion": 1,
      "smartEntryFileVersion": 1,
      "smartEntryRelatedDate": 1536105600000,
      "smartFiles": [
        {
          "smartEntryId": 453,
          "smartFileId": 562,
          "smartFileType": "OUF",
          "smartFileName": "index.html",
          "smartFileBytes": 3297,
          "smartFileMd5": "caa3aab46945ac50eef4a2bd2e147b70",
          "smartFileCreated": 1537938037093,
          "smartFileModified": 1537938037093,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/453/files/562/index.html"
        },
        {
          "smartEntryId": 453,
          "smartFileId": 563,
          "smartFileType": "THMB",
          "smartFileName": "index-88fa2fc1-fc80-4799-9863-4e6a9b1e4e34-tile.jpg",
          "smartFileBytes": 13148,
          "smartFileMd5": "e9e5a0894af678ca5ff9af221bcdb6b6",
          "smartFileCreated": 1537938037149,
          "smartFileModified": 1537938037149,
          "smartFileURL": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/smartlibs/347/entries/453/files/563/index-88fa2fc1-fc80-4799-9863-4e6a9b1e4e34-tile.jpg"
        }
      ],
      "smartEntryCategories": [],
      "smartEntryUrlLink": "https://google.com",
      "smartEntryAuthors": "Aaron, Peter, Archana",
      "smartEntryURLs": [],
      "smartEntryTags": [
        {
          "smartTagId": 108,
          "smartTagName": "Tag1"
        }
      ],
      "smartEntryFolders": [],
      "smartEntryFilters": [
        {
          "smartFilterId": 21,
          "smartFilterName": "Filter1"
        }
      ]
    }
  ],
  "smartLibFolders": [],
  "totalActiveSmartEntries": 2,
  "totalRecords": 2,
  "totalActivePages": 1,
  "userCanUpload": true
}

Response Headers

Header	Description
`x-nextinteract-tmp-access-token`	AWS access key for temporary access
`x-nextinteract-tmp-secret-token`	AWS secret key for temporary access
`x-nextinteract-tmp-session-token`	AWS session token for temporary access
`x-nextinteract-tmp-token-expiry-seconds`	Number of seconds till the above expire
`x-nextinteract-tmp-token-expiry-datetime-millis`	Actual UTC date/time millis when the above will expire
`x-nextinteract-s3-region`	The AWS region in which STS, Cognito etc relate to. Often needed by AWS SDK or signing

Errors

Exception	Description
`WSInvalidParameterException`	See Error Definitions
`WSInvalidAuthTokenException`	See Error Definitions
`WSCacheServiceException`	See Error Definitions
`WSInsufficientPrivilegesException`	See Error Definitions
`WSSmartLibNotFoundException`	See Error Definitions
`WSBrochureNotFoundException`	See Error Definitions
`WSAuthorisationServiceException`	See Error Definitions
`WSAwsExpiredTokenException`	See Error Definitions
`WSCognitoServiceException`	See Error Definitions
`WSSmartLibraryServiceException`	See Error Definitions
`WSSTSServiceException`	See Error Definitions
`WSS3ServiceException`	See Error Definitions

findSmartEntriesForSmartLibrary ​

Request ​

Headers ​

Parameters ​

Response ​

200 OK ​

Response Headers ​

Errors ​