FIfinos
Application

Retrieve an application definition

get/v2/apps/{appId}

Request

Path parameters

appIdstring required

Response

OK

appIdstring required

The unique application identifier located within a specific application directory instance.

namestring required

The name of the application. The name should be unique within an FDC3 App Directory instance. The exception to the uniqueness constraint is that an App Directory can hold definitions for multiple versions of the same app. The same appName could occur in other directories. We are not currently specifying app name conventions in the document.

type'web' | 'native' | 'citrix' | 'onlineNative' | 'other' required

The technology type that is used to launch and run the application. Each application type implies a particular set of launch details. The supported types include:

  • web: Web applications launched via a URL
  • native: Native applications pre-installed on a device and launch via a filesystem path
  • citrix: Apps virtualized via Citrix
  • onlineNative: Native apps that have an online launcher, e.g. online ClickOnce app deployments.
  • other: Used to represent apps that do not conform to or cannot be launched via the other types, and are likely to be defined solely by a hostManifest.

FDC3 Desktop Agents MUST support at least the web application type and MAY support any or all of the other types.

versionstring

Version of the application. This allows multiple app versions to be defined using the same app name. This can be a triplet but can also include things like 1.2.5 (BETA)

titlestring

Optional title for the application, if missing use appName, typically used in a launcher UI.

tooltipstring

Optional tooltip description e.g. for a launcher

langstring

A language tag that specifies the primary language of both the application and its AppD entry, as defined by IETF RFC 5646.

descriptionstring

Description of the application. This will typically be a 1-2 paragraph style blurb about the application.

categoriesstring[]

An array of string categories that describe the application. These are meant as a hint to catalogs or stores listing FDC3-enabled apps and it is expected that these will make a best effort to find appropriate categories (or category) under which to list the app. AppD record authors are encouraged to use lower-case and, where possible, to select categories from the following list:

  • allocations
  • analytics
  • charts
  • chat
  • communication
  • compliance
  • crm
  • developer tools
  • events
  • execution management
  • file sharing
  • market data
  • news
  • networking
  • office apps
  • order management
  • other
  • portfolio management
  • presentation
  • pricing
  • productivity
  • research
  • risk
  • screen sharing
  • security
  • spreadsheet
  • trade cost analysis
  • trading system
  • training
  • travel
  • video
  • visualization
  • weather
contactEmailstring email

Optional e-mail to receive queries about the application

supportEmailstring email

Optional e-mail to receive support requests for the application

moreInfostring uri

Optional URL that provides more information about the application

publisherstring

The name of the company that owns the application. The publisher has control over their namespace/app/signature.

hostManifestsHostManifests

A mapping from host name to a host-specific application manifest object or URI from which that manifest can be retrieved. The manifest should provide details required to launch and use the application within the specified host. The manifest MAY duplicate or override information provided in the details field.

localizedVersionsLocalizedVersions

Provides localized alternatives to any field of the AppD record, which may also refer to an alternative version of the application that is also localized (e.g. by providing customConfig or an alternative URL). The keys to this object should be language tags as defined by IETF RFC 5646, e.g. en, en-GB or fr-FR.

Changes

No recorded changes to this operation across all 1 revision of this API.