@salesforce/cli 2.62.4 → 2.62.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/npm-shrinkwrap.json +649 -1573
- package/oclif.lock +709 -1060
- package/oclif.manifest.json +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.62.
|
|
27
|
+
@salesforce/cli/2.62.5 linux-x64 node-v20.17.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -903,7 +903,7 @@ EXAMPLES
|
|
|
903
903
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
904
904
|
```
|
|
905
905
|
|
|
906
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
906
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.1/src/commands/api/request/graphql.ts)_
|
|
907
907
|
|
|
908
908
|
## `sf api request rest [URL]`
|
|
909
909
|
|
|
@@ -911,8 +911,8 @@ Make an authenticated HTTP request using the Salesforce REST API.
|
|
|
911
911
|
|
|
912
912
|
```
|
|
913
913
|
USAGE
|
|
914
|
-
$ sf api request rest [URL] -o <value> [--flags-dir <value>] [
|
|
915
|
-
|
|
914
|
+
$ sf api request rest [URL] -o <value> [--flags-dir <value>] [-i | -S Example: report.xlsx] [-X
|
|
915
|
+
GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [-f file | -b file]
|
|
916
916
|
|
|
917
917
|
ARGUMENTS
|
|
918
918
|
URL Salesforce API endpoint
|
|
@@ -923,13 +923,13 @@ FLAGS
|
|
|
923
923
|
-X, --method=<option> HTTP method for the request.
|
|
924
924
|
<options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
|
|
925
925
|
-b, --body=file File or content for the body of the HTTP request. Specify "-" to read from
|
|
926
|
-
standard input or "" for an empty body.
|
|
926
|
+
standard input or "" for an empty body. If passing a file, prefix the
|
|
927
|
+
filename with '@'.
|
|
927
928
|
-f, --file=file JSON file that contains values for the request header, body, method, and
|
|
928
929
|
URL.
|
|
929
930
|
-i, --include Include the HTTP response status and headers in the output.
|
|
930
931
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
931
932
|
`target-org` configuration variable is already set.
|
|
932
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
933
933
|
|
|
934
934
|
GLOBAL FLAGS
|
|
935
935
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -946,30 +946,30 @@ DESCRIPTION
|
|
|
946
946
|
EXAMPLES
|
|
947
947
|
List information about limits in the org with alias "my-org":
|
|
948
948
|
|
|
949
|
-
$ sf api request rest 'limits' --target-org my-org
|
|
949
|
+
$ sf api request rest 'services/data/v56.0/limits' --target-org my-org
|
|
950
950
|
|
|
951
951
|
List all endpoints in your default org; write the output to a file called "output.txt" and include the HTTP response
|
|
952
952
|
status and headers:
|
|
953
953
|
|
|
954
|
-
$ sf api request rest '/' --stream-to-file output.txt --include
|
|
954
|
+
$ sf api request rest '/services/data/v56.0/' --stream-to-file output.txt --include
|
|
955
955
|
|
|
956
956
|
Get the response in XML format by specifying the "Accept" HTTP header:
|
|
957
957
|
|
|
958
|
-
$ sf api request rest 'limits' --header 'Accept: application/xml'
|
|
958
|
+
$ sf api request rest '/services/data/v56.0/limits' --header 'Accept: application/xml'
|
|
959
959
|
|
|
960
960
|
Create an account record using the POST method; specify the request details directly in the "--body" flag:
|
|
961
961
|
|
|
962
|
-
$ sf api request rest sobjects/account --body "{\"Name\" : \"Account from REST
|
|
963
|
-
\"Boise\"}" --method POST
|
|
962
|
+
$ sf api request rest /services/data/v56.0/sobjects/account --body "{\"Name\" : \"Account from REST \
|
|
963
|
+
API\",\"ShippingCity\" : \"Boise\"}" --method POST
|
|
964
964
|
|
|
965
|
-
Create an account record using the information in a file called "info.json":
|
|
965
|
+
Create an account record using the information in a file called "info.json" (note the @ prefixing the file name):
|
|
966
966
|
|
|
967
|
-
$ sf api request rest 'sobjects/account' --body info.json --method POST
|
|
967
|
+
$ sf api request rest '/services/data/v56.0/sobjects/account' --body @info.json --method POST
|
|
968
968
|
|
|
969
969
|
Update an account record using the PATCH method:
|
|
970
970
|
|
|
971
|
-
$ sf api request rest 'sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San
|
|
972
|
-
PATCH
|
|
971
|
+
$ sf api request rest '/services/data/v56.0/sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San \
|
|
972
|
+
Francisco\"}" --method PATCH
|
|
973
973
|
|
|
974
974
|
Store the values for the request header, body, and so on, in a file, which you then specify with the --file flag;
|
|
975
975
|
see the description of --file for more information:
|
|
@@ -1012,7 +1012,7 @@ FLAG DESCRIPTIONS
|
|
|
1012
1012
|
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
1013
1013
|
```
|
|
1014
1014
|
|
|
1015
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
1015
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.1/src/commands/api/request/rest.ts)_
|
|
1016
1016
|
|
|
1017
1017
|
## `sf autocomplete [SHELL]`
|
|
1018
1018
|
|