GET api/v1.0/ResourceLibrary/GetLibraryList

Returns a list of Libraries that the Current User is Allowed to View/Join.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of Libraries.

Collection of DocumentLibrary
NameDescriptionTypeAdditional information
Community

Community

None.

EntryCount

integer

None.

CreatedOn

date

None.

IsCommunityRelated

boolean

None.

CanPost

boolean

None.

CanView

boolean

None.

LastApprovedDocumentCreatedOn

date

None.

LastApprovedDocumentOrFileCreatedOn

date

None.

LastApprovedFileCreatedOn

date

None.

LibraryDescription

string

None.

LibraryKey

globally unique identifier

None.

LibraryName

string

None.

LibraryUrl

string

None.

ModerationType

ModerationTypeRef

None.

NumApprovedEntries

integer

None.

NumApprovedFiles

integer

None.

NumApprovedImages

integer

None.

NumApprovedVideos

integer

None.

SecurityRolesRequiredView

Collection of string

None.

SecurityRolesRequiredViewInfo

Collection of string

None.

SecurityRolesRequiredViewInfoList

string

None.

SecurityRolesRequiredViewList

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Community": null,
    "EntryCount": 1,
    "CreatedOn": "2024-03-28T19:43:43.8800646Z",
    "IsCommunityRelated": true,
    "CanPost": true,
    "CanView": true,
    "LastApprovedDocumentCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LastApprovedDocumentOrFileCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LastApprovedFileCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LibraryDescription": "sample string 6",
    "LibraryKey": "ed1a9660-b87b-4be8-a538-56a890239c75",
    "LibraryName": "sample string 8",
    "LibraryUrl": "sample string 9",
    "ModerationType": null,
    "NumApprovedEntries": 1,
    "NumApprovedFiles": 1,
    "NumApprovedImages": 1,
    "NumApprovedVideos": 1,
    "SecurityRolesRequiredView": [
      "sample string 1",
      "sample string 2"
    ],
    "SecurityRolesRequiredViewInfo": [
      "sample string 1",
      "sample string 2"
    ],
    "SecurityRolesRequiredViewInfoList": "sample string 10",
    "SecurityRolesRequiredViewList": "sample string 11"
  },
  {
    "Community": null,
    "EntryCount": 1,
    "CreatedOn": "2024-03-28T19:43:43.8800646Z",
    "IsCommunityRelated": true,
    "CanPost": true,
    "CanView": true,
    "LastApprovedDocumentCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LastApprovedDocumentOrFileCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LastApprovedFileCreatedOn": "2024-03-28T19:43:43.8800646Z",
    "LibraryDescription": "sample string 6",
    "LibraryKey": "ed1a9660-b87b-4be8-a538-56a890239c75",
    "LibraryName": "sample string 8",
    "LibraryUrl": "sample string 9",
    "ModerationType": null,
    "NumApprovedEntries": 1,
    "NumApprovedFiles": 1,
    "NumApprovedImages": 1,
    "NumApprovedVideos": 1,
    "SecurityRolesRequiredView": [
      "sample string 1",
      "sample string 2"
    ],
    "SecurityRolesRequiredViewInfo": [
      "sample string 1",
      "sample string 2"
    ],
    "SecurityRolesRequiredViewInfoList": "sample string 10",
    "SecurityRolesRequiredViewList": "sample string 11"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.