Cisco Cisco Prime Collaboration Provisioning 11.2 Developer's Guide

Page of 82
 
 
© 2016 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
Page 16 of 82 
o  ENUM indicating return key attributes only, all attributes, or selected attributes. 
o  An attribute list that is applied if the above selection requires it. The key attribute and all 
attributes in this list will be returned. 
The CupmApiFilter class is used to define the acceptance criteria on the lists returned by the NBI list commands. 
The filter contains metadata pairs of attribute name and value, where value is a string that can be set to a specific 
value or a regular expression. Metadata can be groups t
o support ‘and’ and ‘or’ queries. A null filter is allowed for 
generating a list of all instances of that object. For the supported string, see 
Infrastructure Product Key Attributes
Table 7: Status Code ENUMS for CupmApiStatusValue  Attribute 
Attribute Name 
Attribute Type 
Description 
returnedDataCriteri 
aValue 
ENUM 
Specifies the attributes to be returned with each object. 
• KEY_AND_SPECIFIED 
• KEYS_ONLY 
• ALL 
additionalStatus 
anyType 
Only type ServiceDetailStatus will be the value returned by the server for the 
additionalStatus attribute. The ServiceDetailStatus contains the current status 
of each detail in a work order. 
Complete Object Definition File: Common.xsd 
Infrastructure Product Key Attributes 
 lists the key attributes for infrastructure products. Any infrastructure product not listed does not have any 
key attributes. 
Table 8: Infrastructure Key Attributes 
Infrastructure Product 
Key Attributes 
Call Park 
IC_pattern 
Call Pickup Group 
IC_name 
Calling Search Space 
IC_name 
Common Device Config 
IC_name 
CTI Route Point 
IC_name 
Device Pool 
IC_name 
H323 Gateway 
IC_name 
Hunt List 
IC_name 
Hunt Pilot 
IC_pattern 
Line Group 
IC_name 
Location 
IC_name 
Media Resource Group 
IC_name 
Media Resource Group 
List 
IC_name 
Route Group 
IC_name 
Route List 
IC_name 
Route Partition 
IC_name 
Route Pattern 
IC_pattern/IC_routePartitionName 
SIP Trunk 
IC_name 
Translation Pattern 
IC_pattern/IC_routePartitionName 
Unified CM Group 
IC_name