Skip to main content

FDC3 Application Directory (next)

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

200
400
403
500

Content type

application/json

Example

A sample app definition that describes the app's use of interop.

{"appId": "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",
"fdc3Version": "^2.2",
"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": {"contexts": ["fdc3.instrument"
]
},
"myApp.GetPrice": {"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": [{"id": "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

200
400
403
500

Content type

application/json

{"applications": [{"appId": "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",
"fdc3Version": "^2.2",
"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": {"contexts": ["fdc3.instrument"
]
},
"myApp.GetPrice": {"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": [{"id": "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",
"title": "FDC3 Workbench",
"description": "Development and test tool for FDC3 desktop agents and apps",
"categories": ["developer tools",
"training"
],
"version": "1.0.0",
"fdc3Version": ">=2.2",
"tooltip": "FDC3 Workbench",
"lang": "en-US",
"icons": [{"src": "https://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"
}