Skip to main content

POST /Info/ListingFields/:cube

Returns information about the <listingField> elements available in the InterSystems IRIS namespace that you access via this REST call.

URL Parameters

cube Required. Logical name of the cube. This name can include slashes; see “Use of Slashes in Cube and KPI Names,” earlier in this book.

Request Body Details

This service ignores the request body.

Example Request

Example Response

{
                         "Info": {
                                  "Error":"","BaseCube":"holefoods"
                         },
                         "Result": {
                                  "ListingFields": [
                                          {"caption":"Channel","expression":"%EXTERNAL(Channel) Channel"},
					{"caption":"City","expression":"Outlet->City"},
					{"caption":"Comment","expression":"Comment"},
				...]
			}
		}

In the response object, the Result property contains a property called ListingFields, which contains an array of objects, one for each <listingField> element.

For information that applies to all response objects, see the discussion at the start of this reference.

Feedback