RetrieveTaggedResources

TagService / RetrieveTaggedResources

Description: Retrieve tagged resources

URL: http://{your-server-url}/api/v1/core/tags/tagresources

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}
currentaccountid: {accountid - optional and default value is user's own account}
currentuserid: {switch to user id}

Rights:

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

Right	Require	Comment
Portal_Adminstrator	Optional	Required either one for switch user
Account_Adminstrator	Optional

Request Query Parameters:

Parameter	Type	Nullable	Description
clearexsitingtags	boolean	True	clear exsiting tag
page	int	True	page number
rpp	int	True	records per page, will retrieve all by default
slugs	string	True	comma separated values, eg. slugs=slug1,slug2
resourcescope	Contract.Model.Enums.Resource.Scope	True	resourcescope must have value
resourceids	int[]	True	comma separated values, eg. resourceids=1,2,3
includereadonly	boolean	True	include read only resources, eg. includereadonly=true

Example: http://{your-server-url}/api/v1/core/tags/tagresources?page=100&rpp=100&slugs=string

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Tag.TagResponse

Parameter	Type
Response.TaggedResources	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Tag.TaggedResource[]
Response.CurrentPage	int
Response.TotalPages	int
Response.TotalCount	int
Response.Rpp	int

Enums:

Field	Name	Values
ResourceScope	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope	Undefined = 0, Portal = 1, Account_Groups = 2, Accounts = 3, Networks = 4, Applications = 5, Players = 6, User_Groups = 7, Users = 8, Zones = 9, DataSources = 10, ContentSize = 11, Server = 12, Content = 13, Campaign = 14, Client = 15, Site = 16, Widget = 17, LayoutSchedule = 18, CampaignEntity = 19, ContentFolders = 20, Layouts = 21, MediaZone = 22, Player_Groups = 23, Space = 24

The following is an example response Xml body:

<TagResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Tag" 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>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TaggedResources xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Tag">
    <a:TaggedResource>
      <a:AccountId>123</a:AccountId>
      <a:Id>123</a:Id>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceScope>Player_Groups</a:ResourceScope>
      <a:Tag>String</a:Tag>
    </a:TaggedResource>
  </TaggedResources>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</TagResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TaggedResources":[
		{
			"AccountId":123,
			"Id":123,
			"ResourceId":123,
			"ResourceScope":23,
			"Tag":"String"
		}
	],
	"TotalCount":123,
	"TotalPages":123
}