RetrieveContents

LibraryService / RetrieveContents

Description: Retrieve contents by queries

URL: http://{your-server-url}/api/v1/core/libraries/contents

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}
currentuserid: {switch to user id}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator, Content Manager, Widget Manager

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require
Content_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
allaccounts	boolean	True	include resources from all accessible accounts, eg. allaccounts=true
contentids	int[]	True	comma separated values, eg. contentids=1,2,3
groupids	int[]	True	-1 represent not in folder. comma separated values, eg. groupids=-1,1,2,3
name	string	True	name
title	string	True	title
types	Contract.Model.Enums.Contents.Type[]	True	comma separated values, eg. types=image,video,pdf
isdeleted	boolean	True	is deleted set to false by default., eg. isdeleted=false
includeextrainfo	boolean	True	include extra information, eg. includeextrainfo=false
tags	string[]	True	comma separated values, eg. tags=tag1,tag2
filter	string	True	comma separated values, eg. filter=none
sort	string	True	sort by createddate, e.g. sort=createddate
sortdir	string	True	sort by ascending or descending, e.g. sortdir=desc or sortdir=asc
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500
externalids	string[]	True	comma separated values, eg. externalids=ext1,ext2
sources	string[]	True	comma separated values, eg. sources=source1,source2,source3

Example: http://{your-server-url}/api/v1/core/libraries/contents?contentids=1,2,3&groupids=1,2,3&name=string

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Library.LibraryResponse

Parameter	Type
Response.CurrentPage	int
Response.Contents	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Contents.Content[]
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
Type	Nexus.AppSpace.Service.Contract.Model.Enums.Content.Type	Undefined = 0, Image = 1, Video = 2, Audio = 3, Script = 4, Slide_Show = 5, ASTexture = 6, Flash = 7, Mtg = 8, PDF = 9, Television = 10, Dynamic_Media = 11, Digital_Television = 12, Web_Page = 13, External_Content = 14, PowerPoint = 15, Nexus_Remote_Desktop = 16, HTML_Text = 17, Folder = 100
Filter	Nexus.AppSpace.Service.Contract.Model.Enums.Content.Filter	Undefined = 0, None = 1, Local = 2, Allocated = 3

The following is an example response Xml body:

<LibraryResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Library" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <Contents xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Contents">
    <a:Content>
      <a:BaseFile>String</a:BaseFile>
      <a:CreatedDate>2015-08-25T17:17:39.5599973Z</a:CreatedDate>
      <a:Description>String</a:Description>
      <a:ExpiryDate>2015-08-25T17:17:39.560998Z</a:ExpiryDate>
      <a:ExternalId>String</a:ExternalId>
      <a:Filter>Allocated</a:Filter>
      <a:GroupId>123</a:GroupId>
      <a:Height>123</a:Height>
      <a:Id>123</a:Id>
      <a:IsDeleted>true</a:IsDeleted>
      <a:LastUsed>2015-08-25T17:17:39.560998Z</a:LastUsed>
      <a:MetaData xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:MetaData>
      <a:Size>1000</a:Size>
      <a:Source>String</a:Source>
      <a:Tags>String</a:Tags>
      <a:Title>String</a:Title>
      <a:Type>HTML_Text</a:Type>
      <a:Usage>123</a:Usage>
      <a:UserGroupId>123</a:UserGroupId>
      <a:Width>123</a:Width>
    </a:Content>
  </Contents>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</LibraryResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Contents":[
		{
			"BaseFile":"String",
			"CreatedDate":"\/Date(1440523059559)\/",
			"Description":"String",
			"ExpiryDate":"\/Date(1440523059560)\/",
			"ExternalId":"String",
			"Filter":3,
			"GroupId":123,
			"Height":123,
			"Id":123,
			"IsDeleted":true,
			"LastUsed":"\/Date(1440523059560)\/",
			"MetaData":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Size":1000,
			"Source":"String",
			"Tags":"String",
			"Title":"String",
			"Type":17,
			"Usage":123,
			"UserGroupId":123,
			"Width":123
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123
}