Entity metadata reference

The ALM Octane public REST API is fully metadata-driven. All entities described by metadata resources can be accessed via the REST API as resource collection.

Note: This API supports only the GET operation.

URI

The table below lists the URIs for the different levels.

Level URI
Workspace level

http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/entities

Shared space level

http[s]://<server>:<port>/api/shared_spaces/<space_id>/metadata/entities

Site level

http[s]://<server>:<port>/admin/metadata/entities

Notes

  • The URI supports filtering by name.

  • For the syntax for specifying parameters in URIs, see Variables and values.

Back to top

Properties

Entity Description
Name

The entity name for which the metadata is defined.

Field name: name
Features

Array of features supported by an entity. For a list of the supported features, see Entity features.

Each item is a JSON object.

Field name: features
Description A description of the entity.
Label A label for the entity, typically displayed in the ALM Octane UI.

Back to top

Defect entity example

The entities resource returns metadata about the data returned for a member of a collection. The following example shows the metadata for the Defect entity. 

        {
            "features": [
                {
                    "parent_types": [
                        "feature",
                        "work_item_root"
                    ],
                    "max_depth": 4,
                    "root": {
                        "type": "work_item_root",
                        "id": "1001"
                    },
                    "name": "hierarchy",
                    "child_types": []
                },
                {
                    "methods": [
                        "DELETE",
                        "POST",
                        "GET",
                        "PUT"
                    ],
                    "name": "rest",
                    "url": "defects"
                },
                {
                    "name": "mailing",
                    "url": "mails"
                },
                {
                    "name": "attachments",
                },
                {
                    "name": "phases"
                },
                {
                    "name": "subtype_of",
                    "type": "work_item"
                },
                {
                    "name": "user_defined_fields"
                },
                {
                    "name": "comments",
                },
                {
                    "name": "business_rules"
                }
            ],
            "name": "defect",
            "description": "A problem detected in the application.",
            "label": "Defect",
            "type": "entity_metadata"
        },

Back to top

See also: