Videoscape Control Suite 3.5.2
Operator Messaging Service API
Guide
Overview
Introduction
This document describes the data model and API of the Cisco Operator
Messaging Service (OMS).
Document Version
This is the second formal release of this document, which was updated for
Version 3.5.2 of the Cisco Videoscape Control Suite.
In This Document
OMS API Conventions ...............................................................................................3
Create Message ........................................................................................................4
Update Message .......................................................................................................6
Delete Message......................................................................................................... 7
Publish Message........................................................................................................8
Send Message to User...............................................................................................10
Send Message to Device............................................................................................12
List Groups ...............................................................................................................14
Get Group ……..........................................................................................................15
Update Group...........................................................................................................16
List Subscribers….....................................................................................................17
Add Group….............................................................................................................19
Delete Group ..............................................................................................................21
List Messages............................................................................................................. 22
Retrieve Messages..................................................................................................... 24
Get Historical Messages ........................................................................................... 26
Get Historical Message Details ............................................................................... 29
1
List Rules .................................................................................................................... 31
Add Rule .................................................................................................................... 32
Delete Rule................................................................................................................. 34
List Rule Parameters................................................................................................. 35
Add Rule Parameter ................................................................................................. 36
Delete Rule Parameter..............................................................................................38
Get Rule Parameter….............................................................................................. 39
Update Rule Parameter............................................................................................40
Get Rule………………............................................................................................. .4 1
Update Rule ..............................................................................................................42
2
OMS API Conventi on s
OMS API Conventions
Request Headers
The following headers apply in the same manner to all OMS requests.
General HTTP
Request Headers
Description
[Content-Type]
The content type that the client is
prepared to accept in the response.
Default value is application/xml.
Possible Error Codes
The possible error codes returned by this call are:
3001, 3002, 3003, 3004, 3005, 3006, 3007, 3008, 3009
Error
Code
Description
3001
Group-related error; for example, the OMS group
does not exist, fails to list groups, or fails to retrieve
group information.
3002
Subscriber-related error; for example, a failure to list
subscribers or retrieve subscriber information.
3003
Message-related error; for example, message does
not exist , a failure to retrieve a message, or an
invalid message transmission.
3004
Initialization error; for example, a failure to initialize
the OMS.
3005
Configuration error; for example, a failure to
configure the OMS.
3006
Message publishing error; for example, a failure to
publish a message through Pubsub.
3007
UPM-related error; for example, a failure to retrieve
user information from the UPM service.
3008
Database-related error; for example, a failure to store
group information or historic messages in the
database.
3009
Rule-related error; for example, an incorrect rule or
rule parameter information.
3
Create Message
Create Message
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=create
Message
Request Body
Parameter
Type
Mandatory
Description
arg0
OMS
Message
Yes
The OMS message
OMS Message
Parameter
Type
Mandatory
Description
fileName
String
Yes
The file name of the message in
the FTP server.
message
String
Yes
A URL-encoded string of the
OMS message body.
validated
Boolean
Yes
Default is true.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "
<createMessage><arg0>goqamNewFile</fileName><message><oms
xmlns='http://conductor.cisco.com/oms/1.0'><sender>pu
[email protected]</sender>
<senderName>Luke
Smith</senderName><expireTime>2016-1217T14:57:00+08:00<
/expireTime><priority>3</priority><type>P
romotion</type><scope>Public<
/scope><title>Title
1</title><description>XML encoded
content.</description><
4
Create Messa ge
payload>XML encoded
payload.</payload></oms></message><validated>true<
/validated>
</arg0></createMessage>"209.165.200.3:8100/service/OMSService?
method=createMessage
Response Example:
<creat eMes sage Resp onse></createMessageResponse>
5
Update Message
Update Message
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=update
Message
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The FileId (file ID) of the
OMS mess a g e
arg1
OMS
Message
Yes
The OMS message
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "
<updateMessage><arg0>34912151-3578-46cc-adf9b76808d7e943</arg0><arg1>
goqamUpdatedNewFile</fileName><message><oms
xmlns='http://conductor.cisco.com/oms/1.0'><
sender>[email protected]</sender><senderName
>Luke Smith</senderName>< expireTime>2016-1217T14:57:00+08:00</expireTime><priority>3</prio
rity>
<type>Promotion</type><scope>Public</scop
e>
<title>Title 1</title><description>XML
encoded content.</description>
<payload>XML encoded
payload.</payload></oms>
</message><validated>true</validated></arg1></updateMessage>"
http://209.165.200.3:8100/service/OMSService?method=updateMess
age
Response Example:
<updat eMes sage Resp onse></updateMessageResponse>
6
Delete Message
Delete Message
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete
Message
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The FileId (file ID) of the
OMS message
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
"<deleteMessage><arg0>34912151-3578-46cc-adf9b76808d7e943</arg0>
</deleteMessage>"
http://209.165.200.3:8100/service/OMSService?method=deleteMess
age
7
Publish Message
Publish Message
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=publis
hMessage
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of OMS group. The
group should have previously
been created.
arg1
OMS
Yes
Message
The data structure of the OMS
message.
OMS Message
Parameter
Type
Mandatory
Description
fileName
String
Yes
The file name of the message .
message
String
Yes
A URL-encoded string of the
OMS message body.
validated
Boolean
Yes
Default is true.
true: The message has been
validated and it is a valid
message.
false: It is an invalid message.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<publishMessage>
<arg0>groupcd01</arg0>
<arg1>
goqamexample.xml</fileName>
<message><oms
xmlns='http://conductor.cisco.com/oms/1.0'>
8
Publish Message
<sender>[email protected]</sender>
<senderName>username1</senderName>
<expireTime>2012-1217T14:57:00+08:00</expireTime>
<priority>3</priority>
<type>Promotion</type>
<scope>Public</scope>
<title>A title of message</title>
<description>
XML encoded content.
</description>
<payload>
XML encoded payload.
</payload>
</oms></message>
<validated>true</validated>
</arg1>
</publishMessage>
http://209.165.200.3:8100/service/OMSService?method=publishMes
sage
Response Example:
<publi shMe ssag e></ publishMessage>
9
Send Message
Send Message to User/Household
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=sendMe
ssage
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The user’s ID in the UPM
database. The user should
already exist in UPM
arg1
OMS
Message
Yes
The data structure of the OMS
message.
OMS Message
Parameter
Type
Mandatory
Description
fileName
String
Yes
The file name of the message
message
String
Yes
A URL-encoded string of the
OMS message body.
validated
Boolean
Yes
Default is true.
true: The message has been
validated and it is a valid
message.
false: It is an invalid message.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<sendMessage>
<arg0>groupcd01_user0</arg0>
<arg1>
goqamexample.xml</fileName>
10
Send Messa ge
<message><oms
xmlns='http://conductor.cisco.com/oms/1.0'>
<sender>[email protected]</sender>
<senderName>username1</senderName>
<expireTime>2012-1217T14:57:00+08:00</expireTime>
<priority>3</priority>
<type>Promotion</type>
<scope>Public</scope>
<title>A title of message</title>
<description>
XML encoded content.
</description>
<payload>
XML encoded payload.
</payload>
</oms></message>
<validated>true</validated>
</arg1>
</sendMessage>
http://209.165.200.3:8100/service/OMSService?method=sendMessag
e
Response Example
<sendM essa ge>< /sen dMessage>
11
Send Message
Send Message to Device
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=sendMe
ssageToDevice
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The device ID in the UPM
database. The device should
already exist in UPM
arg1
OMS
Message
Yes
The data structure of the OMS
message.
Request Example
http://10.90.187.192:8100/service/OMSService?method=sendMessageToDe
vice
Content-Type: application/xml
<sendMessageToDevice><arg0>DEVICE714-1</arg0><arg1><message><oms
xmlns="http://conductor.cisco.com/oms/1.0"><sender>pubsub.
features</sender>
<senderName>Lois Alston</senderName><expireTime>
2016-1217T14:57:00+08:00</expireTime><priority>1</priority&
gt;<type>Ad</type><scope>Private</scope><
;title>ExampleTitle</title><description>Desc</des
cription><payload>XMLPayload</payload></oms></
message><validated>true</validated><fileName>DebbieFile</fileName><
/arg1></sendMessageToDevice>
-- response -200 OK
Server: Apache-Coyote/1.1
12
Content-Type: application/xml
Content-Length: 59
Date: Fri, 03 Oct 2014 18:39:46 GMT
<sendMessageToDeviceResponse></sendMessageToDeviceResponse>
13
List Groups
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=listGr
oups
Request Body
None
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "<listGroups/>"
http://209.165.200.3:8100/service/OMSService?method=listGroups
Response Example
<listG roup sRes pons e>
<return >
<creat eTime>2011-1 1-15T02:37:39+00:00</createTime>
<descr iption></description>
<grpId >1</grpId>
<grpNa me>restful</grpName>
<grpTy pe>user</grpType>
<rules >cityrule1:city=shanghai</rules>
<statu s>2</status>
</return >
</list Grou psRe spon se>
14
List Subscribers
Get Group
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=getGr
oup
Request Body
None
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" –data
"<getGroup><arg0>House</arg0></getGroup>"
http://10.90.187.192:8100/service/OMSService?method=getGroup
Response Example
<getGr oupR espo nse>
<return >
<creat eTime>2014-0 9-26T02:49:11+00:00</createTime>
<descr iption>update</description>
<grpId >112</grpId>
<grpNa me>House</grpName>
<grpTy pe>user</grpType>
<rules >AtlHouseRule:upm.filters.household.metadata.com _ci
sco_om s.province=atlanta;</rules>
<statu s>0</status>
</return >
</getG roup Resp onse >
15
Update Group
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=update
Group
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the group to be
updated
arg1
String
Yes
The updated group Paraemeters.
Only Descriptions can be
d t d
Request Example
curl -l -H "Content-Type:application/xml" --user restful:conductor
-X "POST" --data
"<updateGroup><arg0>HouseGroup</arg0><arg1><createTime>2014-0924T16:12:22+00:00</createTime><description>test for
edit</description><grpId>104</grpId><grpName>HouseGroup</grpName><
grpType>user</grpType><rules>AtlHouseRule:upm.filters.household.me
tadata.com_cisco_oms.province=atlanta;</rules><status>2</status></
arg1></updateGroup>"
http://10.90.187.192:8100/service/OMSService?method=updateGroup
Response Example
<updateGroupResponse></updateGroupResponse>
16
List Subscribers
List Subscribers
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=listSu
bscribers
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the group to list
the subscriber
arg1
Int
Yes
Start index of list, default is 0
arg2
Int
Yes
End index of list; default is
(size-1). For example, the
end should be 49 if you want
to list the first 50 subscribers.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<listSubscribers>
<arg0>restful</arg0>
<arg1>0</arg1>
<arg2>49</arg2>
</listSubscribers>
http://209.165.200.3:8100/service/OMSService?method=listSubscr
ibers
Response Example
<listS ubsc ribe rsRe sponse>
<retur n>
<count >1</count>
<resul t>
<userId>oms_user_username1</userId>
<name>oms_user_username1</name>
<paramet ers>
17
List Subscribers
<paramName>key1</paramName>
<paramValue>shanghai</paramValue>
</parame ters>
<paramet ers>
<paramName>key2</paramName>
<paramValue>pudong</paramValue>
</parame ters>
<paramet ers>
<paramName>province</paramName>
<paramValue>shanghai</paramValue>
</parame ters>
</resu lt>
</retu rn>
</list Subs crib ersR esponse>
18
Add Group
Add Group
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=addGro
up
Request Body
Parameter
Type
Mandatory
Description
arg0
OMS group
Yes
The data structure of the
group.
OMS Group
Parameter
Type
Mandatory
Description
grpId
String
Yes
Default is empty; assigned
by backend.
grpType
String
Yes
Default is ‘user’.
createTime
String
Yes
Default is 0; generated by
back end.
grpName
String
Yes
Default source is GUI.
rules
String
Yes
The rule of this group.
Format is <rule
name>:<rule
key>=<rule value>.
A rule can contain multiple
key/value pairs, which are
separated by a semicolon.
description
String
No
The description of this
group.
status
String
Yes
The status of this group:
0 — normal
1 — sync with UPM service
2 — error
19
Add Group
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<addGroup>
<arg0>
<grpId></grpId>
<grpType>user</grpType>
<createTime>0</createTime>
<grpName>restful</grpName>
<rules>cityrule1:city=shanghai</rules>
<description></description>
<status>0</status>
</arg0>
</addGroup>
http://209.165.200.3:8100/service/OMSService?method=addGroup
Request Response
<addGr oupR espo nse> </addGroupResponse>
20
Delete Group
Delete Group
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete
Group
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the group to delete.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<deleteGroup>
<arg0>restful</arg0>
</deleteGroup>
http://209.165.200.3:8100/service/OMSService?method=deleteGrou
p
Response Example
<delet eGro upRe spon se></deleteGroupResponse>
21
List Messages
List Messages
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=listMe
ssages
Request Body
none
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "<listMessages/>"
http://209.165.200.3:8100/service/OMSService?method=listMessag
es
Response Example
<listM essa gesR espo nse>
<return>
goqamt est_sender_1.xml</filename>
<lastM odTime>2012-10-23T16:00:00+00:00</lastModTime>
<size> 1464</size>
<user> 0</user>
</return >
<return>
goqamt est_sender_2.xml</filename>
<lastM odTime>2012-10-23T16:00:00+00:00</lastModTime>
<size> 1465</size>
<user> 0</user>
</return >
<return>
goqamt est_sender_3.xml</filename>
<lastM odTime>2012-10-23T16:00:00+00:00</lastModTime>
<size> 434</size>
<user> 0</user>
</return >
22
List Messag e s
<retur n>
goqamt est_sender_4.xml</filename>
<lastM odTime>2012-10-23T16:00:00+00:00</lastModTime>
<size> 421</size>
<user> 0</user>
</retu rn>
<retur n>
goqamt est_sender_5.xml</filename>
<lastM odTime>2012-10-23T16:00:00+00:00</lastModTime>
<size> 503</size>
<user> 0</user>
</retu rn>
<retur n>
</list Mess ages Resp onse>
23
Retrieve Messages
Retrieve Messages
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=retrie
veMessages
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The file name to be retrieved.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<retrieveMessages>
<arg0>test_sender_1.xml</arg0>
</retrieveMessages>
http://209.165.200.3:8100/service/OMSService?method=retrieveMe
ssages
Response Example
<retri eveM essa gesR esponse>
<return>
goqamt est_sender_1.xml</fileName>
<messa ge><?xml version='1.0' encoding='utf-8'?>
<oms
xmlns= "htt p:// cond uctor.cisco.com/oms/1.0">
<sender>ssssssss</sender>
<senderName>username1</senderName>
<expireTime>2012-1217T14: 57:0 0+08 :00& lt;/expireTime>
<priority>3</priority>
<type>Promotion</type>
<scope>Test</scope>
<title>A title of message</title>
<desc ripti on>
24
Retrieve Messa ge s
Content.
</des cript ion> ;
<payload>
Payload.
</pay load& gt;
</oms >< /messa ge>
<validat ed>tr ue</va lidat ed>
</retu rn>
</retr ieve Mess ages Response>
25
Get Historical Messages
Get Historical Messages
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=getHis
toricMessages
Request Body
Parameter
Type
Mandatory
Description
arg0
Type
Yes
Search type; default type
is range.
arg1
Search keyword
Yes
Search keyword. For
range search, the
keyword could be one of
‘from’ or ‘to’.
arg2
Search value
Yes
Search value
corresponding to search
keyword.
arg3
Search keyword
Yes
Search keyword. For
range search, the
keyword could be one of
‘from’ or ‘to’.
arg4
Search value
Yes
Search value
corresponding to search
keyword.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<getHistoricMessages>
<arg0>
<type>range</type>
<key>from</key>
<value>0</value>
</arg0>
<arg0>
<type>range</type>
26
Get Historical Messa g e s
<key>to</key>
<value>2</value>
</arg0>
</getHistoricMessages>
http://209.165.200.3:8100/service/OMSService?method=getHistori
cMessages
Response Example
<getHi stor icMe ssag esResponse>
<return>
<count >33</count>
<query Criteria>
<key>fro m</ke y>
<type>ra nge</ type>
<value>0 </val ue>
</quer yCriteria>
<query Criteria>
<key>to< /key>
<type>ra nge</ type>
<value>2 </val ue>
</quer yCriteria>
<resul ts>
<expireTime>2012-12-17T14:57:00+08:00</expireTime>
<failRea son>< /failR eason >
goqamchinese_msg2.xml</fileName>
<msgId>3 319</ msgId>
<msgType >1</m sgType >
<prority >3</p rority >
<receiver>group_chinese</receiver>
<scope>P ublic </scop e>
<sendResult>0</sendResult>
<sendTime>2012-07-27T02:41:45+00:00</sendTime>
<sender>[email protected]</sender>
<senderName>username1</senderName>
<title>I ntern </titl e>
<type>Pr omoti on</ty pe>
</resu lts>
27
Get Historical Messages
<resul ts>
<expireTime>2012-12-17T14:57:00+08:00</expireTime>
<failRea son>< /failR eason >
goqamchinese_msg2.xml</fileName>
<msgId>3 318</ msgId>
<msgType >1</m sgType >
<prority >3</p rority >
<receiver>group_chinese</receiver>
<scope>P ublic </scop e>
<sendResult>0</sendResult>
<sendTime>2012-07-27T02:37:16+00:00</sendTime>
<sender>[email protected]</sender>
<senderName>username1</senderName>
<title>I ntern </titl e>
<type>Pr omoti on</ty pe>
</resu lts>
</retu rn>
</getH isto ricM essa gesResponse>
28
Get Historical Message Details
Get Historical Message Details
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=getHis
toricMessageDetail
Request Body
Parameter
Type Mandatory
Description
arg0
long
The unique message ID of a
specific message.
Yes
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<getHistoricMessageDetail>
<arg0>3319</arg0>
</getHistoricMessageDetail>
http://209.165.200.3:8100/service/OMSService?method=getHistori
cMessageDetail
Response Example
<getHi stor icMe ssag eDetailResponse>
<retur n>
<descr ipti on>I ntern,Intern,Intern,Intern,Intern,Intern,</descr
iption >
<expir eTime>2012-1 2-17T14:57:00+08:00</expireTime>
<failR eason></failReason>
goqamc hinese_msg2.xml</fileName>
<msgId >3319</msgId>
<msgTy pe>1</msgType>
<paylo ad>this is the payload</payload>
<prori ty>3</prority>
<recei ver>group_chinese</receiver>
<scope >Public</scope>
29
Get Historical Message Details
<sendR esult>0</sendResult>
<sendT ime>2012-07-27T02:41:45+00:00</sendTime>
<sende r>[email protected]</sender>
<sende rName>username1</senderName>
<title >Intern</title>
<type> Promotion</type>
</retu rn>
</getH isto ricM essa geDetailResponse>
30
List Rules
List Rules
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=listRu
les
Request Body
None
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "<listRules/>"
http://209.165.200.3:8100/service/OMSService?method=listRules
Response Example
<listR ules Resp onse >
<return>
<descr iption></description>
<opera tor>EqualTo</operator>
<param eter>city</parameter>
<ruleN ame>cityrule1</ruleName>
<type> List</type>
<value >shanghai</value>
</return >
</list Rule sRes pons e>
31
Add Rule
Add Rule
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=addRul
e
Request Body
Parameter
Type
Mandatory
Description
arg0
Rule
Yes
The data structure of the rule.
Parameter
Type
Mandatory
Description
ruleName
String
Yes
The name of the rule.
description
String
No
The description of the rule
parameter.
type
String
Yes
The possible types of rule
parameters are:
Rule
String
List
parameter
String
Yes
The name of the rule parameter
used by this rule.
operator
String
Yes
The default operator is
‘EqualTo’.
value
String
Yes
The value of the rule parameter
used by this rule.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<addRule>
<arg0>
<ruleName>cityrule1</ruleName>
<description></description>
<type>List</type>
32
Add Rule
<parameter>city</parameter>
<operator>EqualTo</operator>
<value>shanghai</value>
</arg0>
</addRule>
Response Example
<addRu leRe spon se>< /addRuleResponse>
33
Delete Rule
Delete Rule
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete
Rule
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule to delete.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<deleteRule>
<arg0>cityrule1</arg0>
</deleteRule>
http://209.165.200.3:8100/service/OMSService?method=deleteRule
Response Example
<delet eRul eRes pons e></deleteRuleResponse>
34
List Rule Parameters
List Rule Parameters
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=listRu
leParameters
Request Body
None
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data "<listRuleParameters/>"
http://209.165.200.3:8100/service/OMSService?method=listRulePa
rameters
Response Example
<listR uleP aram eter sResponse>
<return>
<descr iption></description>
<ruleP arameterName>city</ruleParameterName>
<seqNu m>3</seqNum>
<sourc e>GUI</source>
<type> List</type>
<value >shanghai;beijing</value>
</retu rn>
</list Rule Para mete rsResponse>
35
Add Rule Parameter
Add Rule Parameter
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=addRul
eParameter
Request Body
Parameter
Type
Mandatory
Description
arg0
RuleParameter
Yes
The data structure of the rule
parameter.
Rule Parameter
Parameter
Type
Mandatory
Description
ruleParameterName
String
Yes
The name of the rule
parameter.
type
String
Yes
The possible types of rule
parameters are:
String
List
value
String
Yes
The value of the rule
parameter is String. If there are
multiple strings, the separator
is ‘;’.
source
String
Yes
Default source is ‘GUI’.
description
String
No
The description of rule
parameter.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<addRuleParameter>
<arg0>
<ruleParameterName>city</ruleParameterName>
<type>List</type>
<value>shanghai;beijing</value>
36
Add Rule Paramet e r
<source>GUI</source>
<description></description>
</arg0>
</addRuleParameter>
http://209.165.200.3:8100/service/OMSService?method=addRulePar
ameter
Response Example
<addRu lePa rame terR esponse></addRuleParameterResponse>
37
Delete Rule Parameter
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=delete
RuleParameter
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule parameter to
delete.
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
<deleteRuleParameter>
<arg0>city</arg0>
</deleteRuleParameter>
http://209.165.200.3:8100/service/OMSService?method=deleteRule
Parameter
Response Example
<delet eRul ePar amet erResponse></deleteRuleParameterResponse>
38
Get Rule Parameter
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=get
RuleParameter
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule parameter .
Request Example
curl -l -H "Content-Type:application/xml" --user
restful:conductor -X "POST" --data
"<getRuleParameter><arg0>upm.filters.device.type</arg0></getRule
Parameter>"
http://10.90.187.192:8100/service/OMSService?method=getRuleParam
eter
Response Example
<getRuleParameterResponse><return><description>Edited
Description</description><ruleParameterName>upm.filters.device.ty
pe</ruleParameterName><seqNum>0</seqNum><source>GUI</source><type
>List</type><value>UNMANAGED</value></return></getRuleParameterRe
sponse>
39
Update Rule Parameter
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=updateRuleP
arameter
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule parameter to
be updated.
arg1
String
Yes
The updated rule parameter’s parameters. Note can
only be updated if not in use by a rule. Name
parameter cannot be updated.
Request Example
curl -l -H "Content-Type:application/xml" --user restful:conductor
-X "POST" --data
"<updateRuleParameter><arg0>upm.filters.device.deviceType</arg0><ar
g1><description>update to description and
value</description><ruleParameterName>upm.filters.device.deviceType
</ruleParameterName><seqNum>0</seqNum><source>GUI</source><type>Lis
t</type><value>Gateway;iPad;STB</value></arg1></updateRuleParameter
>"
http://10.90.187.192:8100/service/OMSService?method=updateRuleParam
eter
Response Example
<updateRuleParameterResponse></updateRuleParameterResponse>
40
Get Rule
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=getRule
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule to retrieve.
Request Example
curl -l -H "Content-Type:application/xml" --user restful:conductor
-X "POST" --data "<getRule><arg0>DeviceMetadata</arg0></getRule>"
http://10.90.187.192:8100/service/OMSService?method=getRule
Response Example
<getRuleResponse><return><description>test</description><operator>EqualTo</operator><para
meter>upm.filters.device.metadata.com_cisco_oms.region</parameter><ruleName>DeviceMetad
ata</ruleName><type>String</type><value>shanghai</value></return></getRuleResponse>
41
Update Rule
Request URI
Type: @POST
http://{WebServerIP}:{PORT}/service/{OMSService}?method=updateRule
Request Body
Parameter
Type
Mandatory
Description
arg0
String
Yes
The name of the rule to be updated.
arg1
String
Yes
The updated rule’s parameters. Note can only
be updated if not in use by a group. Name
parameter cannot be updated.
Request Example
curl -l -H "Content-Type:application/xml" --user restful:conductor
-X "POST" --data
"<updateRule><arg0>RuleEdit</arg0><arg1><description>Test Desc
Update
Edit</description><operator>EqualTo</operator><parameter>upm.filter
s.device.type</parameter><ruleName>RuleEdit</ruleName><type>String<
/type><value>Gateway</value></arg1></updateRule>"
http://10.90.187.192:8100/service/OMSService?method=updateRule
Response Example
<updateRuleResponse></updateRuleResponse>
42
43
For Information
If You Have Questions
If you have technical questions, contact Cisco Services for assistance. Follow the
menu options to speak with a service engineer.
Americas Headquarters
http://ww w . ci sco. co m
Cisco Systems, Inc.
Tel: 408 526-4000
170 West Tasman Drive
800 553-6387
San Jose, CA 95134-1706
Fax: 408 527-0883
USA
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates
in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
www.cisco.com/go/trademarks.
Third party trademarks mentioned are the property of their respective owners.
The use of the word partner does not imply a partnership relationship between Cisco and any
other company. (1110R)
Product and service availability are subject to change without notice.
© 2014 Cisco and/or its affiliates. All rights reserved.
December 2014
44
© Copyright 2026 Paperzz