Function Categories

Get a collection of function categories

Returns a collection of function categories based on the specified pagination, filtering, and sorting options.

get/functionCategories

Request

  • Base URL: https://example.com/businessRules
  • URL: https://example.com/businessRules/functionCategories
  • Auth: none declared

Query parameters

startinteger

The index of the first function category to return.

limitinteger

The maximum number of function categories to return.

filterstring filter-criteria

The criteria for filtering the function categories. See Filtering in REST APIs.

sortBystring sort-criteria

The criteria for sorting the function categories. See Sorting in REST APIs.

Response

A collection of function categories.

namestring

The name of the collection.

startinteger

The zero-based index of the first item in the collection.

limitinteger

The number of items that were requested for the collection.

countinteger

If populated indicates the number of items in the collection.

acceptstring

A space-delimited list of media types from which an Accept header may be constructed.

versioninteger

The version number of the collection representation. This representation is version 2.

Example response

{
  "items": [
    {
      "creationTimeStamp": "2020-06-01T15:38:30.988Z",
      "modifiedTimeStamp": "2020-06-01T15:38:30.988Z",
      "createdBy": "edmdev",
      "modifiedBy": "edmdev",
      "id": "4f4bf2a3-5eaa-4899-b238-0e3ebd21ef68",
      "name": "statistical_functions",
      "description": "Functions used to calculate various statistics.",
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/businessRules/functionCategories/4f4bf2a3-5eaa-4899-b238-0e3ebd21ef68",
          "uri": "/businessRules/functionCategories/4f4bf2a3-5eaa-4899-b238-0e3ebd21ef68",
          "type": "application/vnd.sas.business.rule.function.category"
        }
      ],
      "version": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.