getApplicationDef

Purpose

Retrieves the full description of a Platform application definition as an XML document. The XML schema for this document can be found at: https://app.infiniteblue.com/webapi/wsdl/metadata.xsd

See Application XML Elements for a description of the Application XML node and an example of its use.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getApplicationDef

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

appId

The original ID of the application.

Required Permissions

One of: VIEW, CREATE, EDIT, DELETE (VIEW by default)

Reviewers, the CQ issue said to change the description of permissions required for getObjectDef. I assumed that the same would apply to all "get" methods. Also, what does VIEW by default mean?

Response

XML document with the application definition description in an Application node.

An application XML generated by this API method will include only the subset of the metadata unlike the application XML generated from UI. The elements that are exported as part of the getApplicationDef API which has a relationship are:

<Application>
<DisplayName>
<DependentDefs>
<DataObjectDefs>
<DataObjectDef> - <Props>, <SingularName>, <PluralName> , <NameTemplate>, <DataFieldDefs> - <DataFieldDef>, <DisplayLabel>, <Description>
<RelationshipDefs> - <RelationshipDef>

The following elements are not exported as a part of the application XML.

<Attributes> - packedId, language
<PostInstallScript>
<PostAppInstallScript>
<PostAppUpdateScript>
<UITemplate>
<DependentDefs> - not included if there is no relationship
<DataObjectDefs> - The missing elements are – <ListViews>, <Actions>, <Statuses>, <Processes>, <Buttons>, <ConversionMaps>, <Charts>, <Gauges>, <Reports>, <Templates>, <Events>, <Questions>, <MobileCards>, and ‘hasPermissions’ attribute in <DataFieldDef>
<Menus>
<WebPageDefs>
<Portals>
<LegacyReports>
<CustomReports>
<Roles>
<HostedFiles>
<CatalogDefs>
<BatchJobs>
<RolePages>
<SeedRecords>