Skip to content

Commit 37fa2b0

Browse files
committed
chore(release): 1.3.7-dev.0 [skip ci]
1 parent 3f06611 commit 37fa2b0

File tree

2 files changed

+61
-3
lines changed

2 files changed

+61
-3
lines changed

README.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ sf plugins
6161

6262
- [`sf api request graphql`](#sf-api-request-graphql)
6363
- [`sf api request rest [URL]`](#sf-api-request-rest-url)
64+
- [`sf api request soap URL`](#sf-api-request-soap-url)
6465

6566
## `sf api request graphql`
6667

@@ -113,7 +114,7 @@ EXAMPLES
113114
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
114115
```
115116

116-
_See code: [src/commands/api/request/graphql.ts](https://github.com/salesforcecli/plugin-api/blob/1.3.6/src/commands/api/request/graphql.ts)_
117+
_See code: [src/commands/api/request/graphql.ts](https://github.com/salesforcecli/plugin-api/blob/1.3.7-dev.0/src/commands/api/request/graphql.ts)_
117118

118119
## `sf api request rest [URL]`
119120

@@ -222,7 +223,64 @@ FLAG DESCRIPTIONS
222223
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
223224
```
224225

225-
_See code: [src/commands/api/request/rest.ts](https://github.com/salesforcecli/plugin-api/blob/1.3.6/src/commands/api/request/rest.ts)_
226+
_See code: [src/commands/api/request/rest.ts](https://github.com/salesforcecli/plugin-api/blob/1.3.7-dev.0/src/commands/api/request/rest.ts)_
227+
228+
## `sf api request soap URL`
229+
230+
Make an authenticated SOAP API request to a Salesforce org.
231+
232+
```
233+
USAGE
234+
$ sf api request soap URL -o <value> --body file [--flags-dir <value>] [--output-file file]
235+
236+
ARGUMENTS
237+
URL SOAP API endpoint
238+
239+
FLAGS
240+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
241+
configuration variable is already set.
242+
--body=file (required) File or XML content for the SOAP Body. Specify "-" to read from standard input.
243+
If passing a file, prefix the filename with '@'. The command will extract the SOAP Body
244+
content if you provide a full SOAP envelope, or use your content as-is if it's just the
245+
method call.
246+
--output-file=file File path to save the SOAP response. If not specified, the response is printed to stdout.
247+
248+
GLOBAL FLAGS
249+
--flags-dir=<value> Import flag values from a directory.
250+
251+
DESCRIPTION
252+
Make an authenticated SOAP API request to a Salesforce org.
253+
254+
This command allows you to make SOAP API requests to Salesforce orgs. You provide the SOAP Body content (the method
255+
call), and the command automatically wraps it in a complete SOAP envelope with authentication headers.
256+
257+
The command constructs a full SOAP envelope with:
258+
259+
- SOAP Header containing SessionHeader with your org's access token
260+
- SOAP Body containing your provided XML content
261+
262+
For more information about the Salesforce SOAP API, see
263+
https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart.htm.
264+
265+
EXAMPLES
266+
Make a SOAP request to get server timestamp using the Partner API:
267+
268+
$ sf api request soap /services/Soap/u/58.0/ --body '<getServerTimestamp/>' --target-org my-org
269+
270+
Read SOAP Body content from a file:
271+
272+
$ sf api request soap /services/Soap/u/58.0/ --body @soap-body.xml --target-org my-org
273+
274+
Save the SOAP response to a file:
275+
276+
$ sf api request soap /services/Soap/u/58.0/ --body '<getServerTimestamp/>' --target-org my-org --output-file \
277+
response.xml
278+
279+
Pipe SOAP Body content from standard input:
280+
$ echo '<getServerTimestamp/>' | sf api request soap /services/Soap/u/58.0/ --body - --target-org my-org
281+
```
282+
283+
_See code: [src/commands/api/request/soap.ts](https://github.com/salesforcecli/plugin-api/blob/1.3.7-dev.0/src/commands/api/request/soap.ts)_
226284

227285
<!-- commandsstop -->
228286

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-api",
33
"description": "A plugin to call API endpoints via CLI commands",
4-
"version": "1.3.6",
4+
"version": "1.3.7-dev.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)