This operation can be used to commit the changes on IOS-XR device. Note: Please use only json payload. xml payload is not supported, it is generated from the framework.
Since Product Version: 1
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/swim/image/commitSample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/commit
<?xml version="1.0" ?>
<SwimCommitJobDTO>
<activateDeviceImageDetailsListDTO>
<activateDeviceImageDetails>
<activateImageDetailsDTOList>
<activationMode>String value</activationMode>
<features>String value</features>
<imageFamily>String value</imageFamily>
<imageFileName>String value</imageFileName>
<imageName>String value</imageName>
<imageType>String value</imageType>
<location>String value</location>
<size>2</size>
<status>String value</status>
<version>String value</version>
</activateImageDetailsDTOList>
<activateImageDetailsDTOList>
<activationMode>Another string value</activationMode>
<features>Another string value</features>
<imageFamily>Another string value</imageFamily>
<imageFileName>Another string value</imageFileName>
<imageName>Another string value</imageName>
<imageType>Another string value</imageType>
<location>Another string value</location>
<size>12</size>
<status>Another string value</status>
<version>Another string value</version>
</activateImageDetailsDTOList>
<commit>true</commit>
<deviceId>String value</deviceId>
<fpd>true</fpd>
<hostname>String value</hostname>
<issuUpgrade>true</issuUpgrade>
<rollBackId>String value</rollBackId>
</activateDeviceImageDetails>
<activateDeviceImageDetails>
<activateImageDetailsDTOList>
<activationMode>String value</activationMode>
<features>String value</features>
<imageFamily>String value</imageFamily>
<imageFileName>String value</imageFileName>
<imageName>String value</imageName>
<imageType>String value</imageType>
<location>String value</location>
<size>2</size>
<status>String value</status>
<version>String value</version>
</activateImageDetailsDTOList>
<activateImageDetailsDTOList>
<activationMode>Another string value</activationMode>
<features>Another string value</features>
<imageFamily>Another string value</imageFamily>
<imageFileName>Another string value</imageFileName>
<imageName>Another string value</imageName>
<imageType>Another string value</imageType>
<location>Another string value</location>
<size>12</size>
<status>Another string value</status>
<version>Another string value</version>
</activateImageDetailsDTOList>
<commit>false</commit>
<deviceId>Another string value</deviceId>
<fpd>false</fpd>
<hostname>Another string value</hostname>
<issuUpgrade>false</issuUpgrade>
<rollBackId>Another string value</rollBackId>
</activateDeviceImageDetails>
<jobDto>
<customFlag>String value</customFlag>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobSpecification>
<runTaskInParallel>true</runTaskInParallel>
<runTaskInSequence>true</runTaskInSequence>
<taskSpecification>
<domainSpecId>String value</domainSpecId>
<taskName>String value</taskName>
</taskSpecification>
</jobSpecification>
<jobType>String value</jobType>
<parameters>
<lazyLoadedEntities>
<entry>
<key>Another string value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</entry>
<entry>
<key>String value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</entry>
</lazyLoadedEntities>
<instanceCreatedOn>1986-07-24T00:00:00+03:00</instanceCreatedOn>
<instanceId>2</instanceId>
<instanceUpdatedOn>1986-07-24T00:00:00+03:00</instanceUpdatedOn>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<propertyName>String value</propertyName>
</parameters>
<parameters>
<lazyLoadedEntities>
<entry>
<key>Another string value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</entry>
<entry>
<key>String value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</entry>
</lazyLoadedEntities>
<instanceCreatedOn>1991-01-11T00:00:00+02:00</instanceCreatedOn>
<instanceId>12</instanceId>
<instanceUpdatedOn>1991-01-11T00:00:00+02:00</instanceUpdatedOn>
<instanceUuid>Another string value</instanceUuid>
<instanceVersion>11</instanceVersion>
<propertyName>Another string value</propertyName>
</parameters>
<userName>String value</userName>
</jobDto>
</activateDeviceImageDetailsListDTO>
<commitParallel>true</commitParallel>
</SwimCommitJobDTO>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/commit.json
{
"SwimCommitJobDTO" : {
"activateDeviceImageDetailsListDTO" : {
"activateDeviceImageDetails" : [{
"activateImageDetailsDTOList" : [{
"activationMode" : "String value",
"features" : "String value",
"imageFamily" : "String value",
"imageFileName" : "String value",
"imageName" : "String value",
"imageType" : "String value",
"location" : "String value",
"size" : 2,
"status" : "String value",
"version" : "String value"
},
{
"activationMode" : "Another string value",
"features" : "Another string value",
"imageFamily" : "Another string value",
"imageFileName" : "Another string value",
"imageName" : "Another string value",
"imageType" : "Another string value",
"location" : "Another string value",
"size" : 12,
"status" : "Another string value",
"version" : "Another string value"
}],
"commit" : true,
"deviceId" : "String value",
"fpd" : true,
"hostname" : "String value",
"issuUpgrade" : true,
"rollBackId" : "String value"
},
{
"activateImageDetailsDTOList" : [{
"activationMode" : "String value",
"features" : "String value",
"imageFamily" : "String value",
"imageFileName" : "String value",
"imageName" : "String value",
"imageType" : "String value",
"location" : "String value",
"size" : 2,
"status" : "String value",
"version" : "String value"
},
{
"activationMode" : "Another string value",
"features" : "Another string value",
"imageFamily" : "Another string value",
"imageFileName" : "Another string value",
"imageName" : "Another string value",
"imageType" : "Another string value",
"location" : "Another string value",
"size" : 12,
"status" : "Another string value",
"version" : "Another string value"
}],
"commit" : false,
"deviceId" : "Another string value",
"fpd" : false,
"hostname" : "Another string value",
"issuUpgrade" : false,
"rollBackId" : "Another string value"
}],
"jobDto" : {
"customFlag" : "String value",
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobSpecification" : {
"runTaskInParallel" : true,
"runTaskInSequence" : true,
"taskSpecification" : {
"domainSpecId" : "String value",
"taskName" : "String value"
}
},
"jobType" : "String value",
"parameters" : [{
"lazyLoadedEntities" : {
"entry" : [{
"key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"instanceCreatedOn" : "1986-07-24T00 : 00 : 00+03 : 00",
"instanceId" : 2,
"instanceUpdatedOn" : "1986-07-24T00 : 00 : 00+03 : 00",
"instanceUuid" : "String value",
"instanceVersion" : 1,
"propertyName" : "String value"
},
{
"lazyLoadedEntities" : {
"entry" : [{
"key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"instanceCreatedOn" : "1991-01-11T00 : 00 : 00+02 : 00",
"instanceId" : 12,
"instanceUpdatedOn" : "1991-01-11T00 : 00 : 00+02 : 00",
"instanceUuid" : "Another string value",
"instanceVersion" : 11,
"propertyName" : "Another string value"
}],
"userName" : "String value"
}
},
"commitParallel" : true
}
}
Sample XML Response Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/commit
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/swim/image/commit" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<SwimJobResultDTO>
<jobId>String value</jobId>
<jobStatus>String value</jobStatus>
</SwimJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/commit.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/swim\/image\/commit",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"SwimJobResultDTO" : {
"jobId" : "String value",
"jobStatus" : "String value"
}
}
}