glossary-values/categories

Use this resource to retrieve a list of glossary categories, optionally including disabled categories.

The primary use of this API is as input to the GET glossary-values API.

Method summary

HTTP Method	Path	Description
GET	/bwl/glossary-values/categories	Use this resource to retrieve a list of glossary categories, optionally including disabled categories.

GET glossary-values/categories

Description: Use this method to retrieve a list of glossary categories.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes. The user must be an account administrator.
Supports OAuth 2 client credentials	Yes using a User Service ID containing Artifact Reporting Category

Parameters

Name	Location	Description	Required	Type
X-IBM-API-Version	Header	The version of this API. If you are programming against the API, you MUST include the version. If omitted, the latest version of the API is used, which might be incompatible with prior versions. The current value is `1.0.0`.	No	String
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String
showAll	Query	If this parameter is set to true, all categories, including disabled categories, are returned. The default value is false.	No	Boolean

Response

Example input

GET a list of glossary categories, including disabled categories.

Using User Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/bwl/glossary-values/categories?showAll=true"

Using Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token"  
"https://your_server_url/bwl/glossary-values/categories?showAll=true"

Using Service ID OAuth 2 client credentials with user context:

curl -i -H "Authorization: Bearer access_token"  
    -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/bwl/glossary-values/categories?showAll=true"

Example output

GET a list of glossary categories, including disabled categories.

[
    {
        "name": "participant-businessowner-expert",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "goal",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "input-output",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "problem",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "system",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "supplier-customer",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "tag",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "CustomProperty-on",
        "category-type": "custom",
        "active-state": "active"
    },
    {
        "name": "CustomProperty-off",
        "category-type": "custom",
        "active-state": "inactive"
    },
    {
        "name": "kpi",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "externalparticipant",
        "category-type": "predefined",
        "active-state": "active"
    },
    {
        "name": "businessunit",
        "category-type": "predefined",
        "active-state": "active"
    }
]

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There was an error processing the request.
401	This user didn't pass authentication. This response could appear for the following reasons: An invalid username or password was provided. This user belongs to multiple accounts and an account wasn't specified in the request.
403	Access is forbidden because you have insufficient permissions. You must be an administrator of the account to list glossary categories.

More details

To get more details about the operations and response values, use a Swagger Editor to view the APIs:

Download the rest-apis.zip file.
Extract the openapi.yaml file.
Open a web browser, and navigate to https://editor-next.swagger.io/.
Import openapi.yaml using the File > Import File option.