RetrieveApplicationProperties

ApplicationService / RetrieveApplicationProperties

Description: Retrieve application properties

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

Method: GET

Token Required: True

Request Headers:

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

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator

Rights:

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

Right	Require
Application_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
rpp	int	True	records per page, default = 50, max = 500
value	string	True
ids	int[]	True	comma separated values, eg. ids=1,2,3
appids	int[]	True	comma separated values, eg. appids=1,2,3
name	string	True
disabled	boolean	True
includereadonly	boolean	True
page	int	True	page number

Example: http://{your-server-url}/api/v1/core/applications/properties?rpp=100&value=string&ids=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Application.ApplicationResponse

Parameter	Type
Response.TotalCount	int
Response.ApplicationProperties	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.ApplicationProperty[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
Type	Nexus.AppSpace.Service.Contract.Model.Enums.Application.Type	Custom = 0, Passive = 1, Interactive = 2, VideoWall = 3
TemplateType	Nexus.AppSpace.Service.Contract.Model.Enums.Application.PassiveType	Instance = 0, ApplicationTemplate = 1, LayoutTemplate = 2

The following is an example response Xml body:

<ApplicationResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Application" 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>
  <ApplicationProperties xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
    <a:ApplicationProperty>
      <a:ApplicationId>123</a:ApplicationId>
      <a:Disable>true</a:Disable>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:Value>String</a:Value>
    </a:ApplicationProperty>
  </ApplicationProperties>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</ApplicationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"ApplicationProperties":[
		{
			"ApplicationId":123,
			"Disable":true,
			"Id":123,
			"Name":"String",
			"Value":"String"
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalCount":123,
	"TotalPages":123
}