Skip to content

Commit

Permalink
fix: edit messages
Browse files Browse the repository at this point in the history
  • Loading branch information
jshackell-sfdc committed Aug 13, 2024
1 parent 8f52788 commit d74d7a8
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions messages/rest.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# summary

Makes an authenticated HTTP request to the Salesforce REST API and prints the response.
Make an authenticated HTTP request to Salesforce REST API and print the response.

# description
# examples

You must specify a Salesforce org to use, either with the --target-org flag or by setting your default org with
the `target-org` configuration variable.
- List information about limits in the org with alias "my-org":

# examples
<%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org

- Get the response in XML format by specifying the "Accept" HTTP header:

- List information about limits in your org <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits'
--target-org my-org
- Get response in XML format by specifying the "Accept" HTTP header:
<%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept:
application/xml',
<%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept: application/xml',

# flags.include.summary

Include HTTP response status and headers in the output.
Include the HTTP response status and headers in the output.

# flags.method.summary

The HTTP method for the request.
HTTP method for the request.

# flags.header.summary

HTTP header in "key:value" format.

# flags.stream-to-file.summary

Stream responses to file.
Stream responses to a file.

# flags.body.summary

The file to use as the body for the request (use "-" to read from standard input, use "" for an empty body).
File to use as the body for the request. Specify "-" to read from standard input; specify "" for an empty body.

0 comments on commit d74d7a8

Please sign in to comment.