Retrieving metadata

The ALM Octane public REST API is fully metadata-driven. You base your REST API requests on the metadata you retrieve for ALM Octane entities and fields.

Entity metadata reference

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/entities

Field metadata reference

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields

See Examples of retrieving metadata.

Note: The metadata you can retrieve depends on the user or API key. For example, to retrieve site-level metadata, the user or API key need to have access to the site level.

See also: