Skip to content

Commit fc84238

Browse files
Merge pull request #684 from webbnh/REST-corrections
Small corrections to REST article
2 parents 9cacaef + d0149f7 commit fc84238

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

content/article/rest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ https://api.softlayer.com/rest/v3/SoftLayer_Account/getHardware.json?objectMask=
176176
```
177177

178178

179-
This URL gets an account's hardware records along with that hardware's associated datacenter, operating system, and network component records. Note that these relational items are separate by semicolons.
179+
This URL gets an account's hardware records along with that hardware's associated datacenter, operating system, and network component records. Note that these relational items are separate by commas.
180180

181181
```bash
182182
https://api.softlayer.com/rest/v3/SoftLayer_Account/getHardware.json?objectMask=mask[datacenter,operatingSystem,networkComponents]
@@ -189,7 +189,7 @@ This URL gets an account's hardware records along with that hardware's associate
189189
https://api.softlayer.com/rest/v3/SoftLayer_Account/Hardware.json?objectMask=mask[datacenter,operatingSystem[passwords],networkComponents]
190190
```
191191

192-
>There are some other ways of specifying object mask, just as `objectMask=datacenter;operatingSystem.passwords;networkComponents`, but for clarity I use the `mask[datacenter,operatingSystem[passwords],networkComponents]` format.
192+
>There are some other ways of specifying object mask, just as `objectMask=datacenter;operatingSystem.passwords;networkComponents`, but for clarity I use the `objectMask=mask[datacenter,operatingSystem[passwords],networkComponents]` format.
193193

194194
Selecting a `local` property in your objectMask will remove all other local properties on that level of your objectMask.
195195

@@ -243,8 +243,8 @@ returns the error:
243243
</root>
244244
```
245245

246-
<p>While it's JSON equivalent:</p>
247-
```
246+
While it's JSON equivalent:
247+
```bash
248248
https://@api.softlayer.com/rest/v3/Nonexistent.json
249249
```
250250
@@ -275,4 +275,4 @@ curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_User_Custom
275275
* `-d '{"parameters": [` tells CURL what data you want to send in. This is a JSON formatted string, and should start with the 'parameters' object. The parameters are in an array, in the order they appear in the documentation.
276276
* `SoftLayer_User_Customer` This method takes in as its first parameter a user object. This is marked in the documentation as the base class that the API expects. You would replace this with a JSON object that fills out all the User_Customer data you want for this new user
277277
* `string, string, boolean` this is the rest of the parameters, they are simple types so just fill out the information as required.
278-
* `'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/createUser'` The API url to send the request to.
278+
* `'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/createUser'` The API url to send the request to.

0 commit comments

Comments
 (0)