GET api/v2.0/ResourceLibrary/GetLibraries

Returns a list of libraries that the Current user is allowed to view/join. This will return a truncated version of the library data.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of Libraries.

Collection of Library
NameDescriptionTypeAdditional information
CommunityKey

Community key of the library.

globally unique identifier

None.

EntryCount

Number of approved entires in the library.

integer

None.

CreatedOn

The date time denoting the creation of the library

date

None.

IsCommunityRelated

Boolean denoting if the library is related to a community.

boolean

None.

CanPost

Boolean denoting if the current user can post to the library.

boolean

None.

CanView

Boolean denoting if the current user can view the library.

boolean

None.

LibraryDescription

Description of the library.

string

None.

LibraryKey

Unique identifier for the specified library.

globally unique identifier

None.

LibraryName

Name of the library.

string

None.

LibraryUrl

URL that will navigate teh user to the library via the web.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CommunityKey": "ff562d8c-8f05-49ec-a04f-3a7e4062cb19",
    "EntryCount": 2,
    "CreatedOn": "2021-12-08T17:42:16.0122515Z",
    "IsCommunityRelated": true,
    "CanPost": true,
    "CanView": true,
    "LibraryDescription": "sample string 7",
    "LibraryKey": "72e9282f-acb5-46a9-ba6c-d78576c91315",
    "LibraryName": "sample string 9",
    "LibraryUrl": "sample string 10"
  },
  {
    "CommunityKey": "ff562d8c-8f05-49ec-a04f-3a7e4062cb19",
    "EntryCount": 2,
    "CreatedOn": "2021-12-08T17:42:16.0122515Z",
    "IsCommunityRelated": true,
    "CanPost": true,
    "CanView": true,
    "LibraryDescription": "sample string 7",
    "LibraryKey": "72e9282f-acb5-46a9-ba6c-d78576c91315",
    "LibraryName": "sample string 9",
    "LibraryUrl": "sample string 10"
  }
]

application/xml, text/xml

Sample:
<ArrayOfLibrary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <Library>
    <CanPost>true</CanPost>
    <CanView>true</CanView>
    <CommunityKey>ff562d8c-8f05-49ec-a04f-3a7e4062cb19</CommunityKey>
    <CreatedOn>2021-12-08T12:42:16.0122515-05:00</CreatedOn>
    <EntryCount>2</EntryCount>
    <IsCommunityRelated>true</IsCommunityRelated>
    <LibraryDescription>sample string 7</LibraryDescription>
    <LibraryKey>72e9282f-acb5-46a9-ba6c-d78576c91315</LibraryKey>
    <LibraryName>sample string 9</LibraryName>
    <LibraryUrl>sample string 10</LibraryUrl>
  </Library>
  <Library>
    <CanPost>true</CanPost>
    <CanView>true</CanView>
    <CommunityKey>ff562d8c-8f05-49ec-a04f-3a7e4062cb19</CommunityKey>
    <CreatedOn>2021-12-08T12:42:16.0122515-05:00</CreatedOn>
    <EntryCount>2</EntryCount>
    <IsCommunityRelated>true</IsCommunityRelated>
    <LibraryDescription>sample string 7</LibraryDescription>
    <LibraryKey>72e9282f-acb5-46a9-ba6c-d78576c91315</LibraryKey>
    <LibraryName>sample string 9</LibraryName>
    <LibraryUrl>sample string 10</LibraryUrl>
  </Library>
</ArrayOfLibrary>