You are here: FME Server Reference Manual > FME Server Services > Utility Services > Catalog Service

Catalog Service

The Catalog service allows us to create web links that users can use to download workspaces, templates, custom formats and custom transformers from FME Server using FME Workbench via .fmc files.

The catalog service allows registered workspaces to be browseable via the web. The purpose of this service is to make it easier to download and load various FME resources into FME Workbench from anywhere on the web. One prominent example is automatic download and loading of FME examples and demos from fmepedia.com.

There are three usages for the catalog service. They are described below.

Generate .fmc File for an FME Workspace

Request Elements

Request URL

http://<host>[:port]/fmecatalog/<repository>/
<workspace>{.format}

Service-Specific Request Parameters

The following table describes the service-specific options.

Name	Value	Description
opt_format	xml \| json Default: xml	The format to respond in
opt_metadata	wps	If this option is set, the Catalog service will return WPS parameter mappings for the specified workspace.

Response Elements

A service response may contain the elements shown in the following table.

Element	Child Elements	Value	Description
statusInfo	message	message string	service failure message

Retrieve the Catalog

Request Elements

Request URL

http://<host>[:port]/fmecatalog/catalog{.format}?

{name[=value]&}

Note: Only repositories to which the requestor has "Read" permission are returned by the Catalog Service. For more information about Web Services authentication, see Authentication and Authorization.

Service-Specific Request Parameters

The following table describes the service-specific options.

Name	Value	Description
opt_format	xml \| json Default: xml	The format to return the response in
opt_repfilter	string	Filter by repository. Use '' at start/end to signal suffix/prefix. Do not use '' for exact match. eg. FME_* will match repositories such as FME_workspaces.
opt_itemtype	WORKSPACE \| CUSTOMFORMAT \| CUSTOMTRANSFORM \| TEMPLATE	Specifies the type of repository items being returned from the catalog. All item types will be returned by default.

Response Elements

A successful service response may contain the elements shown in the following table.

Element	Child Elements	Value	Description
catalog	category	category elements	list of workspaces grouped by repository
category	name	string	name of the repository
	description	string	description of the repository
	workspace customFormat customTransformer	item elements	information about the workspace
workspace customFormat customTransformer	name	string	name of the item
	description	string	description of the item
	url	url string	url of the item

Note: The response may be cached, so it may be necessary to reset the cache for accurate results.

Reset the Cached Responses

It is important to reset the cache for the most up-to-date response.

Request Elements

Request URL

https://<host>[:port]/fmecatalog/resetcache

Safe Software Inc. www.safe.com