Jump to: navigation, search

GetGroup

URL

  • GET /OMResponse/GetGroup/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
Id String 16 chars ID of the group to retrieve.

Mandatory if Name and TenantId are not provided

false true
Name String 255 chars max Name of the group to retrieve.

Mandatory with TenantID if Id is not provided

false true
ReturnChildObjects String true or false Return details of associated object false true false
TenantId Integer The tenant ID of Group to retrieve.

Mandatory with Name if Id is not provided

false true
SubscriberId String **Important**: The subscriber (i.e. line of business) within the tenant false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Id String 16 chars ID of the group true true
Name String 255 chars max Name of the group true true
Description String 255 chars max Description of the group true true
Type String 16 chars max Type of the group true true
Rules KVList List of rules false true
CategoryId String 16 chars false true


Rules KVList

Key ValueType Value Description Mandatory Unique Default
(RuleId) KVList ID of the rule false true


RuleId KVList

Key ValueType Value Description Mandatory Unique Default
Name String 255 chars max Name of the rule true true
Description String 255 chars max Description of the rule false true
RegExId String 16 chars ID of the expression.

Only if ReturnChildObjects=false

false true
RegEx KVList Reg Ex Detail associated.Only if ReturnChildObjects=true true true
ReplacementPattern String Pattern to use for replacement false true
Actions String Pattern to use for replacement false true
TenantId Integer true true


RegEx KVList

Key ValueType Value Description Mandatory Unique Default
Id String 16 chars ID of the reg ex false true
Name String 255 chars max Name of the expression true true
Description String 255 chars max Description of the expression true true
Properties String Properties of the expression false true
Expression String Expression content true true
TenantId Integer true true


Error

FaultCode FaultString Description
201 Missing parameter {0} Mandatory parameter missing
510 {0} not found in database Record is not found in database
732 Invalid Tenant {1} Provided tenant is not configured in UCS

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.