Configuration and Content API Guide

Get Enable Effectivity Groups.

post

/config/sim/v2/setup/effectivityGroups/getEnableEffectivityGroups

Gets all the enable effectivity group records.

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Enable Effectivity groups.

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 1
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of enable effectivity groups record of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":1,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of enable effectivity groups record of the organization.",
            "items":{
                "$ref":"#/definitions/EnableEffectivityGroupv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of enable effectivity groups record of the organization.

Show Source

Array of: object EnableEffectivityGroupv2

{
    "type":"array",
    "description":"Array of enable effectivity groups record of the organization.",
    "items":{
        "$ref":"#/definitions/EnableEffectivityGroupv2"
    }
}

Nested Schema : EnableEffectivityGroupv2

Type: object

Show Source

changeSetId: integer

Unique reference of the inherited effectivity group.

Example: 1
enableEffectivityGroup: boolean

Flag indicating if the effectivity group is enabled or not.

Example: false
hierUnitId: integer

hierUnitId of property where the record is inherited

Example: 1
hierUnitObjNum: integer

Hierarchy unit object number

Example: 1
objectNum: integer

Object Number of the inherited effectivity group

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"hierUnitId of property where the record is inherited",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Hierarchy unit object number",
            "type":"integer",
            "example":1
        },
        "changeSetId":{
            "description":"Unique reference of the inherited effectivity group.",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the inherited effectivity group",
            "type":"integer",
            "example":1
        },
        "enableEffectivityGroup":{
            "description":"Flag indicating if the effectivity group is enabled or not.",
            "type":"boolean",
            "example":false
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details