FDC3 Application Directory (2.0)

Download OpenAPI specification:Download

Application Directory specification providing both interface definition and objects necessary to construct an application directory service.

Application

Retrieve an application definition

Authorizations:

bearerAuth

path Parameters

appId

required

string

Responses

Response samples

Content type

application/json

Example

A sample app definition for an application that describes its use of interop.

{"appId": "my-application",
"name": "my-application",
"title": "My Application",
"description": "An example application that uses FDC3 and fully describes itself in an AppD record.",
"categories": ["market data",
"research",
"news"
],
"version": "1.0.0",
"tooltip": "My example application definition",
"lang": "en-US",
"icons": [{"src": "http://example.domain.com/assets/my-app-icon.png",
"size": "256x256",
"type": "image/png"
}
],
"screenshots": [{"src": "http://example.domain.com/assets/my-app-screenshot-1.png",
"label": "The first screenshot of my example app",
"type": "image/png",
"size": "800x600"
},
{"src": "http://example.domain.com/assets/my-app-screenshot-2.png",
"label": "The second screenshot of my example app",
"type": "image/png",
"size": "800x600"
}
],
"contactEmail": "fdc3@finos.org",
"supportEmail": "fdc3-maintainers@finos.org",
"moreInfo": "http://example.domain.com/",
"publisher": "Example App, Inc.",
"type": "web",
"details": {"url": "http://example.domain.com/app.html"
},
"hostManifests": {"Finsemble": {"window": {"left": 120,
"top": 120,
"width": 600,
"height": 800,
"options": {"minWidth": 75
}
},
"foreign": {"components": {"App Launcher": {"launchableByUser": true
},
"Window Manager": {"FSBLHeader": true,
"persistWindowState": true
}
}
},
"interop": {"autoConnect": true
}
},
"Glue42": {"type": "window",
"details": {"height": 800,
"width": 600,
"left": 120,
"top": 120,
"mode": "tab",
"allowChannels": true,
"loader": {"enabled": true,
"hideOnLoad": true
}
},
"customProperties": {"folder": "FDC3 Toolbox"
}
},
"Web App Manifest": "http://example.domain.com/my-app.json"
},
"interop": {"intents": {"listensFor": {"ViewChart": {"displayName": "View Chart",
"contexts": ["fdc3.instrument"
]
},
"myApp.GetPrice": {"displayName": "Get Price",
"contexts": ["fdc3.instrument"
],
"resultType": "myApp.quote"
}
},
"raises": {"ViewOrders": ["fdc3.instrument",
"fdc3.organization"
],
"StartEmail": ["fdc3.email"
]
}
},
"userChannels": {"broadcasts": ["fdc3.instrument",
"fdc3.organization"
],
"listensFor": ["fdc3.instrument",
"fdc3.organization"
]
},
"appChannels": [{"name": "myApp.quotes,",
"description": "Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,",
"broadcasts": ["myApp.quote"
],
"listensFor": ["fdc3.instrument"
]
}
]
},
"localizedVersions": {"fr-FR": {"title": "Mon application,",
"description": "Un exemple d'application qui utilise FDC3 et se décrit entièrement dans un enregistrement AppD."
}
}
}

Retrieve all application definitions

Authorizations:

bearerAuth

Responses

Response samples

Content type

application/json

{"applications": [{"appId": "my-application",
"name": "my-application",
"title": "My Application",
"description": "An example application that uses FDC3 and fully describes itself in an AppD record.",
"categories": ["market data",
"research",
"news"
],
"version": "1.0.0",
"tooltip": "My example application definition",
"lang": "en-US",
"icons": [{"src": "http://example.domain.com/assets/my-app-icon.png",
"size": "256x256",
"type": "image/png"
}
],
"screenshots": [{"src": "http://example.domain.com/assets/my-app-screenshot-1.png",
"label": "The first screenshot of my example app",
"type": "image/png",
"size": "800x600"
},
{"src": "http://example.domain.com/assets/my-app-screenshot-2.png",
"label": "The second screenshot of my example app",
"type": "image/png",
"size": "800x600"
}
],
"contactEmail": "fdc3@finos.org",
"supportEmail": "fdc3-maintainers@finos.org",
"moreInfo": "http://example.domain.com/",
"publisher": "Example App, Inc.",
"type": "web",
"details": {"url": "http://example.domain.com/app.html"
},
"hostManifests": {"Finsemble": {"window": {"left": 120,
"top": 120,
"width": 600,
"height": 800,
"options": {"minWidth": 75
}
},
"foreign": {"components": {"App Launcher": {"launchableByUser": true
},
"Window Manager": {"FSBLHeader": true,
"persistWindowState": true
}
}
},
"interop": {"autoConnect": true
}
},
"Glue42": {"type": "window",
"details": {"height": 800,
"width": 600,
"left": 120,
"top": 120,
"mode": "tab",
"allowChannels": true,
"loader": {"enabled": true,
"hideOnLoad": true
}
},
"customProperties": {"folder": "FDC3 Toolbox"
}
},
"Web App Manifest": "http://example.domain.com/my-app.json"
},
"interop": {"intents": {"listensFor": {"ViewChart": {"displayName": "View Chart",
"contexts": ["fdc3.instrument"
]
},
"myApp.GetPrice": {"displayName": "Get Price",
"contexts": ["fdc3.instrument"
],
"resultType": "myApp.quote"
}
},
"raises": {"ViewOrders": ["fdc3.instrument",
"fdc3.organization"
],
"StartEmail": ["fdc3.email"
]
}
},
"userChannels": {"broadcasts": ["fdc3.instrument",
"fdc3.organization"
],
"listensFor": ["fdc3.instrument",
"fdc3.organization"
]
},
"appChannels": [{"name": "myApp.quotes,",
"description": "Used to share a stream of quotes for currently displayed instrument and may be used to change the currently displayed symbol,",
"broadcasts": ["myApp.quote"
],
"listensFor": ["fdc3.instrument"
]
}
]
},
"localizedVersions": {"fr-FR": {"title": "Mon application,",
"description": "Un exemple d'application qui utilise FDC3 et se décrit entièrement dans un enregistrement AppD."
}
}
},
{"appId": "fdc3-workbench",
"name": "fdc3-workbench",
"title": "FDC3 Workbench",
"description": "Development and test tool for FDC3 desktop agents and apps",
"categories": ["developer tools",
"training"
],
"version": "1.0.0",
"tooltip": "FDC3 Workbench",
"lang": "en-US",
"icons": [{"src": "http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png"
}
],
"screenshots": [{"src": "https://fdc3.finos.org/docs/assets/fdc3-logo.png",
"label": "FDC3 logo"
}
],
"contactEmail": "fdc3@finos.org",
"supportEmail": "fdc3-maintainers@finos.org",
"publisher": "FDC3,",
"type": "web",
"details": {"url": "https://fdc3.finos.org/toolbox/fdc3-workbench/"
},
"hostManifests": {"Glue42": {"type": "window",
"icon": "https://fdc3.finos.org/docs/assets/fdc3-logo.png",
"details": {"height": 640,
"width": 560,
"left": 120,
"top": 120,
"mode": "tab",
"allowChannels": true,
"loader": {"enabled": true,
"hideOnLoad": true
}
},
"customProperties": {"folder": "FDC3 Toolbox"
}
},
"Finsemble": {"window": {"left": 120,
"top": 120,
"width": 800,
"height": 750,
"options": {"minWidth": 75
}
},
"foreign": {"components": {"App Launcher": {"launchableByUser": true
},
"Toolbar": {"iconURL": "http://fdc3.finos.org/toolbox/fdc3-workbench/fdc3-icon-256.png"
},
"Window Manager": {"FSBLHeader": true,
"persistWindowState": true
}
}
},
"interop": {"autoConnect": true
}
},
"Web App Manifest": "https://example.com/fdc3-workbench.json"
},
"localizedVersions": {"fr-FR": {"title": "FDC3 Table de travail",
"description": "Outil de développement et de test pour les desktop agents et applications FDC3"
}
}
}
],
"message": "OK"
}

Retrieve an application definition Deprecated

Authorizations:

bearerAuth

path Parameters

appId

required

string

Responses

Response samples

Content type

application/json

{"appId": "string",
"name": "string",
"manifest": "string",
"manifestType": "string",
"version": "string",
"title": "string",
"tooltip": "string",
"description": "string",
"images": [{"url": "http://example.com"
}
],
"contactEmail": "user@example.com",
"supportEmail": "user@example.com",
"publisher": "string",
"icons": [{"icon": "http://example.com"
}
],
"customConfig": [{"name": "string",
"value": "string"
}
],
"intents": [{"name": "string",
"displayName": "string",
"contexts": ["string"
],
"customConfig": { }
}
]
}

Create a new application definition Deprecated

Authorizations:

bearerAuth

Request Body schema: application/json
required

appId required	string The unique application identifier located within a specific application directory instance.
name required	string 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.
manifest required	string 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.
manifestType required	string 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.
version	string 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)
title	string Optional title for the application, if missing use appName, typically used in a launcher UI.
tooltip	string Optional tooltip description e.g. for a launcher
description	string Description of the application. This will typically be a 1-2 paragraph style blurb about the application. Allow mark up language
	Array of objects (AppImageV1) Array of images to show the user when they are looking at app description. Each image can have an optional description/tooltip
contactEmail	string <email> Optional e-mail to receive queries about the application
supportEmail	string <email> Optional e-mail to receive support requests for the application
publisher	string The name of the company that owns the application. The publisher has control over their namespace/app/signature.
	Array of objects (IconV1) Holds Icons used for the application, a Launcher may be able to use multiple Icon sizes or there may be a 'button' Icon
	Array of objects (NameValuePair) An optional set of name value pairs that can be used to deliver custom data from an App Directory to a launcher.
	Array of objects (IntentV1) The list of intents implemented by the application as defined by https://github.com/FDC3/Intents/blob/main/src/Intent.yaml

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"name": "string",
"manifest": "string",
"manifestType": "string",
"version": "string",
"title": "string",
"tooltip": "string",
"description": "string",
"images": [{"url": "http://example.com"
}
],
"contactEmail": "user@example.com",
"supportEmail": "user@example.com",
"publisher": "string",
"icons": [{"icon": "http://example.com"
}
],
"customConfig": [{"name": "string",
"value": "string"
}
],
"intents": [{"name": "string",
"displayName": "string",
"contexts": ["string"
],
"customConfig": { }
}
]
}

Response samples

Content type

application/json

{"applications": [{"appId": "string",
"name": "string",
"manifest": "string",
"manifestType": "string",
"version": "string",
"title": "string",
"tooltip": "string",
"description": "string",
"images": [{"url": "http://example.com"
}
],
"contactEmail": "user@example.com",
"supportEmail": "user@example.com",
"publisher": "string",
"icons": [{"icon": "http://example.com"
}
],
"customConfig": [{"name": "string",
"value": "string"
}
],
"intents": [{"name": "string",
"displayName": "string",
"contexts": ["string"
],
"customConfig": { }
}
]
}
],
"message": "string"
}

Retrieve a list of applications based on parameters provided. Depending on implementation, parameter values should self describe search format and type (e.g. Regex) Deprecated

Authorizations:

bearerAuth

query Parameters

appId	string The unique application identifier located within a specific application directory instance.
name	string 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.
version	string 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)
title	string Optional title for the application, if missing use appName, typically used in a launcher UI.
tooltip	string Optional tooltip description e.g. for a launcher
description	string Description of the application. This will typically be a 1-2 paragraph style blurb about the application. Allow mark up language
intent_name	string name of intent
intent_displayName	string displayName of intent
intent_context	string search contexts list

Responses

Response samples

Content type

application/json

{"applications": [{"appId": "string",
"name": "string",
"manifest": "string",
"manifestType": "string",
"version": "string",
"title": "string",
"tooltip": "string",
"description": "string",
"images": [{"url": "http://example.com"
}
],
"contactEmail": "user@example.com",
"supportEmail": "user@example.com",
"publisher": "string",
"icons": [{"icon": "http://example.com"
}
],
"customConfig": [{"name": "string",
"value": "string"
}
],
"intents": [{"name": "string",
"displayName": "string",
"contexts": ["string"
],
"customConfig": { }
}
]
}
],
"message": "string"
}

FDC3 Application Directory (2.0)

Application

Retrieve an application definition

Authorizations:

path Parameters

Responses

Response samples

Retrieve all application definitions

Authorizations:

Responses

Response samples

Retrieve an application definition Deprecated

Authorizations:

path Parameters

Responses

Response samples

Create a new application definition Deprecated

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve a list of applications based on parameters provided. Depending on implementation, parameter values should self describe search format and type (e.g. Regex) Deprecated

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
required