Functions

Get a collection of functions

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

get/functions

Request

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

Query parameters

startinteger

The index of the first function to return.

limitinteger

The maximum number of functions to return.

filterstring filter-criteria

The criteria for filtering the functions. See Filtering in REST APIs.

sortBystring sort-criteria

The criteria for sorting the functions. See Sorting in REST APIs.

Response

A collection of functions.

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-08-04T17:46:19.097Z",
      "modifiedTimeStamp": "2020-08-04T17:47:28.848Z",
      "createdBy": "brmdev",
      "modifiedBy": "brmdev",
      "version": 1,
      "id": "26674236-bc80-41de-954d-d37b1a19d98d",
      "categoryId": "85329ae9-52df-444f-8e18-bffb1a523da7",
      "name": "customadd2",
      "code": "method customAdd2(double a, double b) returns double; return a + b; end;",
      "returnType": "double",
      "signature": [
        {
          "type": "double",
          "name": "a",
          "inOut": false,
          "nameQuoted": false
        },
        {
          "type": "double",
          "name": "b",
          "inOut": false,
          "nameQuoted": false
        }
      ],
      "links": [
        {
          "method": "GET",
          "rel": "self",
          "href": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d",
          "uri": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d",
          "type": "application/vnd.sas.business.rule.function"
        },
        {
          "method": "PUT",
          "rel": "update",
          "href": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d",
          "uri": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d",
          "type": "application/vnd.sas.business.rule.function"
        },
        {
          "method": "DELETE",
          "rel": "delete",
          "href": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d",
          "uri": "/businessRules/functions/26674236-bc80-41de-954d-d37b1a19d98d"
        },
        {
          "method": "GET",
          "rel": "up",
          "href": "/businessRules/functions",
          "uri": "/businessRules/functions",
          "type": "application/vnd.sas.collection",
          "itemType": "application/vnd.sas.business.rule.function"
        },
        {
          "method": "GET",
          "rel": "category",
          "href": "/businessRules/functionCategories/85329ae9-52df-444f-8e18-bffb1a523da7",
          "uri": "/businessRules/functionCategories/85329ae9-52df-444f-8e18-bffb1a523da7",
          "type": "application/vnd.sas.business.rule.function.category"
        }
      ],
      "hidden": false,
      "nameQuoted": false
    }
  ]
}

Changes

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