Dell N3200-ON Networking N-Series Switches RESTful API User Guide version 6.8. - Page 10

Special Keywords and Parameters

Page 10 highlights

Special Keywords and Parameters RESTful APIs support several resource keywords that are used to expand and complement the REST API. The supported keywords are as follows: • debug - Debugging capabilities are available for each request in an effort to assist and provide some insight into the details of the request. Debugging is available and defined using the following levels: • 0: Disabled (default). • 1: Trace. General tracing, may identify OpEN API function and return codes. • 2: Data. Request data is echoed for verification purposes. • 3: Verbose. The highest level of verbosity. - The debug parameter format is ?debug= • fields - The fields parameter is used to identify or reduce the resource content when used with a GET request. By default, the complete data set for the particular resource is returned. The amount of data returned may be overwhelming for some requests. The fields parameter can be used to reduce and identify only the interesting or desired resources. - The fields parameter format is ?fields= ,,... • method - Some clients can make only GET requests and have the inability to make POST, PUT, or DELETE requests. To assist with this limitation, all the APIs can be performed using a GET request using the special method parameter. - The method parameter format is ?method= • offset/limit 10 RESTful OpEN API Overview

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217

10
RESTful OpEN API Overview
Special Keywords and Parameters
RESTful APIs support several resource keywords that are used to expand and
complement the REST API. The supported keywords are as follows:
debug
Debugging capabilities are available for each request in an effort to
assist and provide some insight into the details of the request.
Debugging is available and defined using the following levels:
0: Disabled (default).
1: Trace. General tracing, may identify OpEN API function and
return codes.
2: Data. Request data is echoed for verification purposes.
3: Verbose. The highest level of verbosity.
The
debug
parameter format is
?debug=<level>
fields
The
fields
parameter is used to identify or reduce the resource
content when used with a GET request. By default, the complete data
set for the particular resource is returned. The amount of data
returned may be overwhelming for some requests. The
fields
parameter can be used to reduce and identify only the interesting or
desired resources.
The
fields
parameter format is
?fields=
<resource1>,<resource2>,...
method
Some clients can make only GET requests and have the inability to
make POST, PUT, or DELETE requests. To assist with this limitation,
all the APIs can be performed using a GET request using the special
method
parameter.
The
method
parameter format is
?method=
<post|put|get|delete>
offset/limit