RetrieveDatasources

DatasourceService / RetrieveDatasources

Description: Get Datasources by queries

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

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}

Required Roles:

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

Rights:

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

Right	Require
Widget_Management	Yes
Application_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
datasourceguids	string[]	True	comma separated values, eg. datasourceguids=xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx
appids	int[]	True	comma separated values, eg. appids=1,2,3
datasourceids	int[]	True	comma separated values, eg. datasourceids=1,2,3
mediazoneids	int[]	True	comma separated values, eg. mediazoneids=1,2,3
mediazoneguids	string[]	True	comma separated values, eg. mediazoneguids=xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx
name	string	True	datasource name
type	Contract.Model.Enums.DataSource.DataSourceType	True	datasource type, eg. type=Info_Menu
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/datasources?appids=1,2,3&datasourceids=1,2,3&mediazoneids=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource.DatasourceResponse

Parameter	Type
Response.Datasources	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.DataSource[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
Type	Nexus.AppSpace.Service.Contract.Model.Enums.DataSource.DataSourceType	Undefined = 0, RSS_Component = 1, Text_Ticker_Component = 2, Concierge_Component = 3, Map_Component = 4, Retail_Directory_Component = 5, Info_Menu = 6, Career_Service = 7, Campus_Directory = 8, _3D_Wayfinding = 9, Calendar = 10, Multiscreen = 11, Cinema = 12, Hierarchical_Menu = 13, Room_Scheduler = 14, Store_Advert = 15, RSS_Author = 16, Weather_Info = 17, Poll = 18, Asset = 19, Workbook = 20, Campaign = 21, MediaZone = 22

The following is an example response Xml body:

<DatasourceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource" 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>
  <Datasources xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources">
    <a:DataSource i:type="b:InfoMenuDatasource" xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.InfoMenu">
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:Type>MediaZone</a:Type>
      <b:AssetIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <c:int>123</c:int>
      </b:AssetIds>
      <b:AssetTypeIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <c:int>123</c:int>
      </b:AssetTypeIds>
      <b:InfoMenuItemIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <c:int>123</c:int>
      </b:InfoMenuItemIds>
      <b:MaxLevel>123</b:MaxLevel>
    </a:DataSource>
  </Datasources>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</DatasourceResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Datasources":[
		{
			"__type":"InfoMenuDatasource:#Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.InfoMenu",
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"Name":"String",
			"Type":22,
			"AssetIds":[
				123
			],
			"AssetTypeIds":[
				123
			],
			"InfoMenuItemIds":[
				123
			],
			"MaxLevel":123
		}
	],
	"Rpp":123,
	"TotalPages":123
}