Configuration and Content API Guide

Get Enable Effectivity Groups.

post

/config/sim/v1/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

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 10
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Enable Effectivity groups.

Root Schema : EnableEffGroupsGetResponse

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/EnableEffGroups"
            }
        },
        "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 EnableEffGroups

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

Nested Schema : EnableEffGroups

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
hierUnitName: object hierUnitName

A string that contains translations of hierarchy unit name into multiple languages
hierUnitObjNum: integer

Hierarchy unit object number

Example: 1
name: object name

name of the effectivity group
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
        },
        "hierUnitName":{
            "description":"A string that contains translations of hierarchy unit name into multiple languages",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "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
        },
        "name":{
            "description":"name of the effectivity group",
            "type":"object",
            "example":{
                "en-US":"Effectivity Group 1",
                "es-MX":"Dispositivo de pedido 1"
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}

Nested Schema : name

Type: object

name of the effectivity group

Example:

{
    "en-US":"Effectivity Group 1",
    "es-MX":"Dispositivo de pedido 1"
}