Jump to

• Request
• Response

Update specified SBC devices with specified route set

post

/rest/{versionId}/routeSets/{routeSetId}/devices/action

Use this method to update a subset of associated SBC devices with new route set.User needs provide route set id to be updated on devices as part of resource uri and list of decvices to be updated along with type of action (Update) in request method body.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• routeSetId: string
  The route set id on which update action needs to be performed.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The details of update action. This shoudl have list of Device to be updated.

Root Schema : routeUpdate

Type: object

Show Source

• action(optional): string
• deviceGroups(optional): array deviceGroups
• failureAction(optional): string
• name(optional): string
• notes(optional): string
• routeSets(optional): object routeSets

{
    "properties":{
        "action":{
            "type":"string"
        },
        "deviceGroups":{
            "items":{
                "$ref":"#/definitions/RestRouteDeviceGroup",
                "xml":{
                    "name":"deviceGroup"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "failureAction":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "routeSets":{
            "$ref":"#/definitions/RestRouteSetList"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdate"
    }
}

Nested Schema : deviceGroups

Type: array

Show Source

• Array of: object deviceGroup

{
    "items":{
        "$ref":"#/definitions/RestRouteDeviceGroup",
        "xml":{
            "name":"deviceGroup"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : routeSets

Type: object

Show Source

• pageInfo(optional): object PageInfo
• routeSets(optional): array routeSet

{
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "routeSets":{
            "items":{
                "$ref":"#/definitions/RestRouteSet",
                "xml":{
                    "name":"routeSet"
                }
            },
            "type":"array",
            "xml":{
                "name":"routeSet"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSets"
    }
}

Nested Schema : deviceGroup

Type: object

Show Source

• deviceGroupId(optional): string

{
    "properties":{
        "deviceGroupId":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceGroup"
    }
}

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "properties":{
        "limitation":{
            "format":"int32",
            "type":"integer"
        },
        "numberOfElements":{
            "format":"int64",
            "type":"integer"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : routeSet

Type: array

Show Source

• Array of: object routeSet

{
    "items":{
        "$ref":"#/definitions/RestRouteSet",
        "xml":{
            "name":"routeSet"
        }
    },
    "type":"array",
    "xml":{
        "name":"routeSet"
    }
}

Nested Schema : routeSet

Type: object

Show Source

• addMode(optional): string
• addTaskId(optional): string
• addTaskStatus(optional): string
• copyFromRouteSetId(optional): string
• description(optional): string
• deviceGroupId(optional): string
• deviceLrtConfigName(optional): string
• deviceLrtFilename(optional): string
• deviceRequiresUpdating(optional): string
• lastModifiedTime(optional): string
• lockOwner(optional): string
• lockState(optional): string
• name(optional): string
• notes(optional): string
• pubIdType(optional): string
• routeCount(optional): string
• routeSetId(optional): string
• version(optional): string

{
    "properties":{
        "addMode":{
            "type":"string"
        },
        "addTaskId":{
            "type":"string"
        },
        "addTaskStatus":{
            "type":"string"
        },
        "copyFromRouteSetId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "deviceGroupId":{
            "type":"string"
        },
        "deviceLrtConfigName":{
            "type":"string"
        },
        "deviceLrtFilename":{
            "type":"string"
        },
        "deviceRequiresUpdating":{
            "type":"string"
        },
        "lastModifiedTime":{
            "type":"string"
        },
        "lockOwner":{
            "type":"string"
        },
        "lockState":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "pubIdType":{
            "type":"string"
        },
        "routeCount":{
            "type":"string"
        },
        "routeSetId":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeSet"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : routeUpdateTask

Type: object

Show Source

• devices(optional): string
• failureAction(optional): string
• initiatedBy(optional): string
• initiatedDate(optional): string
• name(optional): string
• notes(optional): string
• objectId(optional): string
• rollbackStatus(optional): string
• routeSets(optional): string

{
    "properties":{
        "devices":{
            "type":"string"
        },
        "failureAction":{
            "type":"string"
        },
        "initiatedBy":{
            "type":"string"
        },
        "initiatedDate":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "rollbackStatus":{
            "type":"string"
        },
        "routeSets":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"routeUpdateTask"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top