FIfinos
Application

Retrieve an application definition

get/v1/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.

manifeststring required

URI or full JSON of the application manifest providing all details related to launch and use requirements as described by the vendor. The format of this manifest is vendor specific, but can be identified by the manifestType attribute.

manifestTypestring required

The manifest type which relates to the format and structure of the manifest content. The definition is based on the vendor specific format and definition outside of this specification.

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

descriptionstring

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

contactEmailstring email

Optional e-mail to receive queries about the application

supportEmailstring email

Optional e-mail to receive support requests for the application

publisherstring

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

Changes

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