Community articleECM Document Types Labels API
Added by IBM contributorIBM on March 26, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.
This API is for getting all existing labels for one or all ECM document types for a given locale.
The locale used is the one received in the HTTP request (The preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server).
Note: The document type IDs are found on search results entries representing ECM files.

Parameters


The order of the parameters in the requests do not matter. The parameter names are case-sensitive; they must be entered in the format documented. Any unknown or unsupported parameters submitted as part of a request will be ignored.

The response is in json format. It contains a json object mapping ID->label
Input
Method URI Description
GET /search/json/labels Get all existing labels for one or all ECM document types for a given locale.
Name Type Optional Description
ecmDocumentType
string Yes The ID of the document type for which we're requesting the label.

This parameter is optional. When specified, only the label matching this document type's ID will be returned. Otherwise, labels of all document types will be returned.
Output
Content Type: application/json
Examples
URL:
search/json/labels?ecmDocumentType=3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;F9A1F1E9-354B-49C5-AEC5-8FC81F2B3A11

Response returned by the server
Response:
{"3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;F9A1F1E9-354B-49C5-AEC5-8FC81F2B3A11":"WebFormTemplate"}
URL:
search/json/labels

Response returned by the server
Response:
{"3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;F9A1F1E9-354B-49C5-AEC5-8FC81F2B3A11":"WebFormTemplate","3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;8ECB343F-E13A-473A-AF9C-29F32872D5D1":"Book","3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;01A3A8C2-7AEC-11D1-A31B-0020AF9FBB1C":"Document","3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;F007569B-B179-40CB-8EE8-D236AEA6C157":"FormData","3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;95D9616A-1800-4499-BE69-8F6B64B82D91":"Email","3F2EE8A3-95EA-4009-9FAC-2F25BAC07DE0;AACA69EF-30E9-44DB-A9F9-0C6157A1AFBA":"FormPolicy"}