adoptai-mcp 1.0.0
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 +70 -0
- package/bin/adoptai-mcp.js +2 -0
- package/dist/apps/canva.js +1 -0
- package/dist/apps/figma.js +1 -0
- package/dist/apps/github.js +2 -0
- package/dist/apps/notion.js +1 -0
- package/dist/apps/registry.js +20 -0
- package/dist/apps/salesforce.js +1 -0
- package/dist/cli/add.js +532 -0
- package/dist/cli/index.js +39 -0
- package/dist/cli/list.js +19 -0
- package/dist/cli/remove.js +37 -0
- package/dist/cli/serve.js +27 -0
- package/dist/cli/status.js +24 -0
- package/dist/config/clients.js +118 -0
- package/dist/config/credentials.js +34 -0
- package/dist/core/auth-manager.js +237 -0
- package/dist/core/config-writer.js +161 -0
- package/dist/core/doctor.js +199 -0
- package/dist/core/package.json +3 -0
- package/dist/core/server-base.js +81 -0
- package/dist/integrations/canva/.env +3 -0
- package/dist/integrations/canva/auth.js +287 -0
- package/dist/integrations/canva/env.js +9 -0
- package/dist/integrations/canva/index.js +12 -0
- package/dist/integrations/canva/package.json +31 -0
- package/dist/integrations/canva/publish-to-adoptai.js +365 -0
- package/dist/integrations/canva/setup.js +90 -0
- package/dist/integrations/canva/tools.js +1315 -0
- package/dist/integrations/canva/tools.original.js +1315 -0
- package/dist/integrations/figma/auth.js +48 -0
- package/dist/integrations/figma/index.js +11 -0
- package/dist/integrations/figma/package.json +27 -0
- package/dist/integrations/figma/publish-to-adoptai.js +384 -0
- package/dist/integrations/figma/setup.js +90 -0
- package/dist/integrations/figma/tools.js +1137 -0
- package/dist/integrations/github/auth.js +53 -0
- package/dist/integrations/github/index.js +11 -0
- package/dist/integrations/github/package.json +28 -0
- package/dist/integrations/github/publish-to-adoptai.js +240 -0
- package/dist/integrations/github/setup.js +103 -0
- package/dist/integrations/github/tools.js +78 -0
- package/dist/integrations/github-actions/auth.js +53 -0
- package/dist/integrations/github-actions/index.js +11 -0
- package/dist/integrations/github-actions/package.json +27 -0
- package/dist/integrations/github-actions/setup.js +103 -0
- package/dist/integrations/github-actions/tools.js +5642 -0
- package/dist/integrations/github-activity/auth.js +53 -0
- package/dist/integrations/github-activity/index.js +11 -0
- package/dist/integrations/github-activity/package.json +27 -0
- package/dist/integrations/github-activity/setup.js +103 -0
- package/dist/integrations/github-activity/tools.js +925 -0
- package/dist/integrations/github-apps/auth.js +53 -0
- package/dist/integrations/github-apps/index.js +11 -0
- package/dist/integrations/github-apps/package.json +27 -0
- package/dist/integrations/github-apps/setup.js +103 -0
- package/dist/integrations/github-apps/tools.js +791 -0
- package/dist/integrations/github-billing/auth.js +53 -0
- package/dist/integrations/github-billing/index.js +11 -0
- package/dist/integrations/github-billing/package.json +27 -0
- package/dist/integrations/github-billing/setup.js +103 -0
- package/dist/integrations/github-billing/tools.js +438 -0
- package/dist/integrations/github-checks/auth.js +53 -0
- package/dist/integrations/github-checks/index.js +11 -0
- package/dist/integrations/github-checks/package.json +27 -0
- package/dist/integrations/github-checks/setup.js +103 -0
- package/dist/integrations/github-checks/tools.js +607 -0
- package/dist/integrations/github-code-scanning/auth.js +53 -0
- package/dist/integrations/github-code-scanning/index.js +11 -0
- package/dist/integrations/github-code-scanning/package.json +27 -0
- package/dist/integrations/github-code-scanning/setup.js +103 -0
- package/dist/integrations/github-code-scanning/tools.js +987 -0
- package/dist/integrations/github-dependabot/auth.js +53 -0
- package/dist/integrations/github-dependabot/index.js +11 -0
- package/dist/integrations/github-dependabot/package.json +27 -0
- package/dist/integrations/github-dependabot/setup.js +103 -0
- package/dist/integrations/github-dependabot/tools.js +915 -0
- package/dist/integrations/github-gists/auth.js +53 -0
- package/dist/integrations/github-gists/index.js +11 -0
- package/dist/integrations/github-gists/package.json +27 -0
- package/dist/integrations/github-gists/setup.js +103 -0
- package/dist/integrations/github-gists/tools.js +545 -0
- package/dist/integrations/github-git/auth.js +53 -0
- package/dist/integrations/github-git/index.js +11 -0
- package/dist/integrations/github-git/package.json +27 -0
- package/dist/integrations/github-git/setup.js +103 -0
- package/dist/integrations/github-git/tools.js +513 -0
- package/dist/integrations/github-issues/auth.js +53 -0
- package/dist/integrations/github-issues/index.js +11 -0
- package/dist/integrations/github-issues/package.json +27 -0
- package/dist/integrations/github-issues/setup.js +103 -0
- package/dist/integrations/github-issues/tools.js +2232 -0
- package/dist/integrations/github-orgs/auth.js +53 -0
- package/dist/integrations/github-orgs/index.js +11 -0
- package/dist/integrations/github-orgs/package.json +27 -0
- package/dist/integrations/github-orgs/setup.js +103 -0
- package/dist/integrations/github-orgs/tools.js +3512 -0
- package/dist/integrations/github-packages/auth.js +53 -0
- package/dist/integrations/github-packages/index.js +11 -0
- package/dist/integrations/github-packages/package.json +27 -0
- package/dist/integrations/github-packages/setup.js +103 -0
- package/dist/integrations/github-packages/tools.js +1088 -0
- package/dist/integrations/github-pulls/auth.js +53 -0
- package/dist/integrations/github-pulls/index.js +11 -0
- package/dist/integrations/github-pulls/package.json +27 -0
- package/dist/integrations/github-pulls/setup.js +103 -0
- package/dist/integrations/github-pulls/tools.js +1252 -0
- package/dist/integrations/github-reactions/auth.js +53 -0
- package/dist/integrations/github-reactions/index.js +11 -0
- package/dist/integrations/github-reactions/package.json +27 -0
- package/dist/integrations/github-reactions/setup.js +103 -0
- package/dist/integrations/github-reactions/tools.js +706 -0
- package/dist/integrations/github-repos/auth.js +53 -0
- package/dist/integrations/github-repos/index.js +11 -0
- package/dist/integrations/github-repos/package.json +27 -0
- package/dist/integrations/github-repos/setup.js +103 -0
- package/dist/integrations/github-repos/tools.js +7286 -0
- package/dist/integrations/github-search/auth.js +53 -0
- package/dist/integrations/github-search/index.js +11 -0
- package/dist/integrations/github-search/package.json +27 -0
- package/dist/integrations/github-search/setup.js +103 -0
- package/dist/integrations/github-search/tools.js +370 -0
- package/dist/integrations/github-teams/auth.js +53 -0
- package/dist/integrations/github-teams/index.js +11 -0
- package/dist/integrations/github-teams/package.json +27 -0
- package/dist/integrations/github-teams/setup.js +103 -0
- package/dist/integrations/github-teams/tools.js +633 -0
- package/dist/integrations/github-users/auth.js +53 -0
- package/dist/integrations/github-users/index.js +11 -0
- package/dist/integrations/github-users/package.json +27 -0
- package/dist/integrations/github-users/setup.js +103 -0
- package/dist/integrations/github-users/tools.js +1118 -0
- package/dist/integrations/notion/api.js +108 -0
- package/dist/integrations/notion/auth.js +59 -0
- package/dist/integrations/notion/endpoints.json +630 -0
- package/dist/integrations/notion/index.js +11 -0
- package/dist/integrations/notion/package.json +33 -0
- package/dist/integrations/notion/publish-to-adoptai.js +271 -0
- package/dist/integrations/notion/scripts/generate-endpoints.mjs +306 -0
- package/dist/integrations/notion/setup.js +89 -0
- package/dist/integrations/notion/tools.js +586 -0
- package/dist/integrations/notion/tools.original.js +568 -0
- package/dist/integrations/salesforce/.env +8 -0
- package/dist/integrations/salesforce/.env.example +15 -0
- package/dist/integrations/salesforce/auth.js +311 -0
- package/dist/integrations/salesforce/endpoints.json +1359 -0
- package/dist/integrations/salesforce/env.js +9 -0
- package/dist/integrations/salesforce/index.js +12 -0
- package/dist/integrations/salesforce/package.json +42 -0
- package/dist/integrations/salesforce/publish-smart-specs.js +890 -0
- package/dist/integrations/salesforce/publish-to-adoptai.js +386 -0
- package/dist/integrations/salesforce/scripts/extract-postman.mjs +222 -0
- package/dist/integrations/salesforce/setup.js +112 -0
- package/dist/integrations/salesforce/tools.js +4544 -0
- package/dist/integrations/salesforce/tools.original.js +4487 -0
- package/dist/server/mcp-server.js +50 -0
- package/dist/server/tool-loader.js +47 -0
- package/dist/specs/figma-api.json +13621 -0
- package/dist/specs/split/salesforce-auth.json +3931 -0
- package/dist/specs/split/salesforce-bulk-v1.json +1489 -0
- package/dist/specs/split/salesforce-bulk-v2.json +1951 -0
- package/dist/specs/split/salesforce-composite.json +1246 -0
- package/dist/specs/split/salesforce-connect.json +11639 -0
- package/dist/specs/split/salesforce-einstein-prediction-service.json +576 -0
- package/dist/specs/split/salesforce-event-platform.json +2682 -0
- package/dist/specs/split/salesforce-graphql.json +1754 -0
- package/dist/specs/split/salesforce-industries.json +4115 -0
- package/dist/specs/split/salesforce-metadata.json +555 -0
- package/dist/specs/split/salesforce-rest.json +4798 -0
- package/dist/specs/split/salesforce-soap.json +210 -0
- package/dist/specs/split/salesforce-subscription-management.json +1299 -0
- package/dist/specs/split/salesforce-tooling.json +2026 -0
- package/dist/specs/split/salesforce-ui.json +7426 -0
- package/package.json +47 -0
|
@@ -0,0 +1,1359 @@
|
|
|
1
|
+
{
|
|
2
|
+
"generatedAt": "2026-03-26T18:12:12.534Z",
|
|
3
|
+
"endpoints": [
|
|
4
|
+
{
|
|
5
|
+
"name": "runexpressionset",
|
|
6
|
+
"description": "# Expression Set Actions\n\nInvoke an active expression set. An expression set is a user-defined rule that accepts an input and returns the output based on the configured function.\n\nThe configured function of an expression set can be a simple decision matrix lookup, a calculation based on a mathematical formula, a condition, or another expression set.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runExpressionSet",
|
|
7
|
+
"method": "POST",
|
|
8
|
+
"path": "/actions/custom/runExpressionSet/{expressionSetAPIName}",
|
|
9
|
+
"urlKind": "versioned",
|
|
10
|
+
"inputSchema": {
|
|
11
|
+
"type": "object",
|
|
12
|
+
"properties": {
|
|
13
|
+
"expressionSetAPIName": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "Path parameter: expressionSetAPIName"
|
|
16
|
+
},
|
|
17
|
+
"inputs": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"description": "Body: inputs"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"required": [
|
|
23
|
+
"expressionSetAPIName"
|
|
24
|
+
]
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "rundecisionmatrix",
|
|
29
|
+
"description": "# Decision Matrix Actions\n\nInvoke a decision matrix in a flow with the Decision Matrix Actions. A decision matrix is a user-defined table where you can look up an output based on the inputs you provide.\n\nFor example, you can look up a candidate’s eligibility to avail medical insurance in a decision matrix based on the candidate’s age and gender.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runDecisionMatrix/{U",
|
|
30
|
+
"method": "POST",
|
|
31
|
+
"path": "/actions/custom/runDecisionMatrix/{UniqueName}",
|
|
32
|
+
"urlKind": "versioned",
|
|
33
|
+
"inputSchema": {
|
|
34
|
+
"type": "object",
|
|
35
|
+
"properties": {
|
|
36
|
+
"UniqueName": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "Path parameter: UniqueName"
|
|
39
|
+
},
|
|
40
|
+
"inputs": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"description": "Body: inputs"
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"required": [
|
|
46
|
+
"UniqueName"
|
|
47
|
+
]
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "standard_invocable_actions",
|
|
52
|
+
"description": "Returns the list of actions that can be statically invoked. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later.",
|
|
53
|
+
"method": "GET",
|
|
54
|
+
"path": "/actions/standard",
|
|
55
|
+
"urlKind": "versioned",
|
|
56
|
+
"inputSchema": {
|
|
57
|
+
"type": "object",
|
|
58
|
+
"properties": {},
|
|
59
|
+
"required": []
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "custom_invocable_actions",
|
|
64
|
+
"description": "Returns the list of all custom actions. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later.",
|
|
65
|
+
"method": "GET",
|
|
66
|
+
"path": "/actions/custom",
|
|
67
|
+
"urlKind": "versioned",
|
|
68
|
+
"inputSchema": {
|
|
69
|
+
"type": "object",
|
|
70
|
+
"properties": {},
|
|
71
|
+
"required": []
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "launch_flow",
|
|
76
|
+
"description": "Launches an Autolaunched Flow with the supplied input parameters.",
|
|
77
|
+
"method": "POST",
|
|
78
|
+
"path": "/actions/custom/flow/{flowApiName}",
|
|
79
|
+
"urlKind": "versioned",
|
|
80
|
+
"inputSchema": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"properties": {
|
|
83
|
+
"flowApiName": {
|
|
84
|
+
"type": "string",
|
|
85
|
+
"description": "Path parameter: flowApiName"
|
|
86
|
+
},
|
|
87
|
+
"inputs": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"description": "Body: inputs"
|
|
90
|
+
}
|
|
91
|
+
},
|
|
92
|
+
"required": [
|
|
93
|
+
"flowApiName"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "quick_actions",
|
|
99
|
+
"description": "Returns a list of global actions and object-specific actions. This resource is available in REST API version 28.0 and later. When working with actions, also refer to SObject Quick Actions.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_quickactions.htm",
|
|
100
|
+
"method": "GET",
|
|
101
|
+
"path": "/quickActions",
|
|
102
|
+
"urlKind": "versioned",
|
|
103
|
+
"inputSchema": {
|
|
104
|
+
"type": "object",
|
|
105
|
+
"properties": {},
|
|
106
|
+
"required": []
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"name": "describe_global",
|
|
111
|
+
"description": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.",
|
|
112
|
+
"method": "GET",
|
|
113
|
+
"path": "/sobjects/",
|
|
114
|
+
"urlKind": "versioned",
|
|
115
|
+
"inputSchema": {
|
|
116
|
+
"type": "object",
|
|
117
|
+
"properties": {},
|
|
118
|
+
"required": []
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "download_file",
|
|
123
|
+
"description": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.",
|
|
124
|
+
"method": "GET",
|
|
125
|
+
"path": "/sobjects/ContentVersion/0681k0000020wLFAAY/VersionData",
|
|
126
|
+
"urlKind": "versioned",
|
|
127
|
+
"inputSchema": {
|
|
128
|
+
"type": "object",
|
|
129
|
+
"properties": {},
|
|
130
|
+
"required": []
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "sobject_basic_information",
|
|
135
|
+
"description": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.",
|
|
136
|
+
"method": "GET",
|
|
137
|
+
"path": "/sobjects/{SOBJECT_API_NAME}",
|
|
138
|
+
"urlKind": "versioned",
|
|
139
|
+
"inputSchema": {
|
|
140
|
+
"type": "object",
|
|
141
|
+
"properties": {
|
|
142
|
+
"SOBJECT_API_NAME": {
|
|
143
|
+
"type": "string",
|
|
144
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"required": [
|
|
148
|
+
"SOBJECT_API_NAME"
|
|
149
|
+
]
|
|
150
|
+
}
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "sobject_create",
|
|
154
|
+
"description": "SObject Create",
|
|
155
|
+
"method": "POST",
|
|
156
|
+
"path": "/sobjects/{SOBJECT_API_NAME}",
|
|
157
|
+
"urlKind": "versioned",
|
|
158
|
+
"inputSchema": {
|
|
159
|
+
"type": "object",
|
|
160
|
+
"properties": {
|
|
161
|
+
"SOBJECT_API_NAME": {
|
|
162
|
+
"type": "string",
|
|
163
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
164
|
+
},
|
|
165
|
+
"Name": {
|
|
166
|
+
"type": "string",
|
|
167
|
+
"description": "Body: Name"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"required": [
|
|
171
|
+
"SOBJECT_API_NAME"
|
|
172
|
+
]
|
|
173
|
+
}
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "sobject_describe",
|
|
177
|
+
"description": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.",
|
|
178
|
+
"method": "GET",
|
|
179
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe",
|
|
180
|
+
"urlKind": "versioned",
|
|
181
|
+
"inputSchema": {
|
|
182
|
+
"type": "object",
|
|
183
|
+
"properties": {
|
|
184
|
+
"SOBJECT_API_NAME": {
|
|
185
|
+
"type": "string",
|
|
186
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"required": [
|
|
190
|
+
"SOBJECT_API_NAME"
|
|
191
|
+
]
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "sobject_get_deleted",
|
|
196
|
+
"description": "Retrieves the list of individual records that have been deleted within the given timespan for the specified object. SObject Get Deleted is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nDeleted records are written to a delete log which this resource accesses. A background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the numbe",
|
|
197
|
+
"method": "GET",
|
|
198
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/deleted/",
|
|
199
|
+
"urlKind": "versioned",
|
|
200
|
+
"inputSchema": {
|
|
201
|
+
"type": "object",
|
|
202
|
+
"properties": {
|
|
203
|
+
"SOBJECT_API_NAME": {
|
|
204
|
+
"type": "string",
|
|
205
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
206
|
+
},
|
|
207
|
+
"start": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "Query: start"
|
|
210
|
+
},
|
|
211
|
+
"end": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"description": "Query: end"
|
|
214
|
+
}
|
|
215
|
+
},
|
|
216
|
+
"required": [
|
|
217
|
+
"SOBJECT_API_NAME"
|
|
218
|
+
]
|
|
219
|
+
}
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"name": "sobject_get_updated",
|
|
223
|
+
"description": "Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. SObject Get Updated is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nResults are returned for no more than 30 days previous to the day the call is executed.\nYour client application can replicate any objects to which it has sufficient permissions. For example, to replic",
|
|
224
|
+
"method": "GET",
|
|
225
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/updated/",
|
|
226
|
+
"urlKind": "versioned",
|
|
227
|
+
"inputSchema": {
|
|
228
|
+
"type": "object",
|
|
229
|
+
"properties": {
|
|
230
|
+
"SOBJECT_API_NAME": {
|
|
231
|
+
"type": "string",
|
|
232
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
233
|
+
},
|
|
234
|
+
"start": {
|
|
235
|
+
"type": "string",
|
|
236
|
+
"description": "Query: start"
|
|
237
|
+
},
|
|
238
|
+
"end": {
|
|
239
|
+
"type": "string",
|
|
240
|
+
"description": "Query: end"
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"required": [
|
|
244
|
+
"SOBJECT_API_NAME"
|
|
245
|
+
]
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "sobject_named_layouts",
|
|
250
|
+
"description": "Retrieves information about alternate named layouts for a given object.",
|
|
251
|
+
"method": "GET",
|
|
252
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe/namedLayouts/{LAYOUT_NAME}",
|
|
253
|
+
"urlKind": "versioned",
|
|
254
|
+
"inputSchema": {
|
|
255
|
+
"type": "object",
|
|
256
|
+
"properties": {
|
|
257
|
+
"SOBJECT_API_NAME": {
|
|
258
|
+
"type": "string",
|
|
259
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
260
|
+
},
|
|
261
|
+
"LAYOUT_NAME": {
|
|
262
|
+
"type": "string",
|
|
263
|
+
"description": "Path parameter: LAYOUT_NAME"
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"required": [
|
|
267
|
+
"SOBJECT_API_NAME",
|
|
268
|
+
"LAYOUT_NAME"
|
|
269
|
+
]
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "sobject_rows",
|
|
274
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
275
|
+
"method": "GET",
|
|
276
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}",
|
|
277
|
+
"urlKind": "versioned",
|
|
278
|
+
"inputSchema": {
|
|
279
|
+
"type": "object",
|
|
280
|
+
"properties": {
|
|
281
|
+
"SOBJECT_API_NAME": {
|
|
282
|
+
"type": "string",
|
|
283
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
284
|
+
},
|
|
285
|
+
"RECORD_ID": {
|
|
286
|
+
"type": "string",
|
|
287
|
+
"description": "Path parameter: RECORD_ID"
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"required": [
|
|
291
|
+
"SOBJECT_API_NAME",
|
|
292
|
+
"RECORD_ID"
|
|
293
|
+
]
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
"name": "sobject_rows_update",
|
|
298
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
299
|
+
"method": "PATCH",
|
|
300
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}",
|
|
301
|
+
"urlKind": "versioned",
|
|
302
|
+
"inputSchema": {
|
|
303
|
+
"type": "object",
|
|
304
|
+
"properties": {
|
|
305
|
+
"SOBJECT_API_NAME": {
|
|
306
|
+
"type": "string",
|
|
307
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
308
|
+
},
|
|
309
|
+
"RECORD_ID": {
|
|
310
|
+
"type": "string",
|
|
311
|
+
"description": "Path parameter: RECORD_ID"
|
|
312
|
+
},
|
|
313
|
+
"field API name": {
|
|
314
|
+
"type": "string",
|
|
315
|
+
"description": "Body: field API name"
|
|
316
|
+
}
|
|
317
|
+
},
|
|
318
|
+
"required": [
|
|
319
|
+
"SOBJECT_API_NAME",
|
|
320
|
+
"RECORD_ID"
|
|
321
|
+
]
|
|
322
|
+
}
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "sobject_rows_delete",
|
|
326
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
327
|
+
"method": "DELETE",
|
|
328
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}",
|
|
329
|
+
"urlKind": "versioned",
|
|
330
|
+
"inputSchema": {
|
|
331
|
+
"type": "object",
|
|
332
|
+
"properties": {
|
|
333
|
+
"SOBJECT_API_NAME": {
|
|
334
|
+
"type": "string",
|
|
335
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
336
|
+
},
|
|
337
|
+
"RECORD_ID": {
|
|
338
|
+
"type": "string",
|
|
339
|
+
"description": "Path parameter: RECORD_ID"
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
"required": [
|
|
343
|
+
"SOBJECT_API_NAME",
|
|
344
|
+
"RECORD_ID"
|
|
345
|
+
]
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "sobject_rows_by_external_id",
|
|
350
|
+
"description": "Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.\n\nIf the specified value doesn't exist, a new record is created.\nIf a record does exist with that value, the field values specified in the request body are updated.\nIf the value is not unique, the REST API returns a 300 response with the list of matching records.\n\nHEAD, GET, PATCH, DELETE, POST",
|
|
351
|
+
"method": "GET",
|
|
352
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{FIELD_NAME}/{FIELD_VALUE}",
|
|
353
|
+
"urlKind": "versioned",
|
|
354
|
+
"inputSchema": {
|
|
355
|
+
"type": "object",
|
|
356
|
+
"properties": {
|
|
357
|
+
"SOBJECT_API_NAME": {
|
|
358
|
+
"type": "string",
|
|
359
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
360
|
+
},
|
|
361
|
+
"FIELD_NAME": {
|
|
362
|
+
"type": "string",
|
|
363
|
+
"description": "Path parameter: FIELD_NAME"
|
|
364
|
+
},
|
|
365
|
+
"FIELD_VALUE": {
|
|
366
|
+
"type": "string",
|
|
367
|
+
"description": "Path parameter: FIELD_VALUE"
|
|
368
|
+
}
|
|
369
|
+
},
|
|
370
|
+
"required": [
|
|
371
|
+
"SOBJECT_API_NAME",
|
|
372
|
+
"FIELD_NAME",
|
|
373
|
+
"FIELD_VALUE"
|
|
374
|
+
]
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "sobject_blob_retrieve",
|
|
379
|
+
"description": "Retrieves the specified blob field from an individual record.",
|
|
380
|
+
"method": "GET",
|
|
381
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/{BLOB_FIELD}",
|
|
382
|
+
"urlKind": "versioned",
|
|
383
|
+
"inputSchema": {
|
|
384
|
+
"type": "object",
|
|
385
|
+
"properties": {
|
|
386
|
+
"SOBJECT_API_NAME": {
|
|
387
|
+
"type": "string",
|
|
388
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
389
|
+
},
|
|
390
|
+
"RECORD_ID": {
|
|
391
|
+
"type": "string",
|
|
392
|
+
"description": "Path parameter: RECORD_ID"
|
|
393
|
+
},
|
|
394
|
+
"BLOB_FIELD": {
|
|
395
|
+
"type": "string",
|
|
396
|
+
"description": "Path parameter: BLOB_FIELD"
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
"required": [
|
|
400
|
+
"SOBJECT_API_NAME",
|
|
401
|
+
"RECORD_ID",
|
|
402
|
+
"BLOB_FIELD"
|
|
403
|
+
]
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "sobject_approvallayouts",
|
|
408
|
+
"description": "Returns a list of approval layouts for a specified object. Specify a particular approval process name to limit the return value to one specific approval layout. This resource is available in REST API version 30.0 and later.\n\napprovalProcessName parameter is optional",
|
|
409
|
+
"method": "GET",
|
|
410
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe/approvalLayouts/{APPROVAL_PROCESS_NAME}",
|
|
411
|
+
"urlKind": "versioned",
|
|
412
|
+
"inputSchema": {
|
|
413
|
+
"type": "object",
|
|
414
|
+
"properties": {
|
|
415
|
+
"SOBJECT_API_NAME": {
|
|
416
|
+
"type": "string",
|
|
417
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
418
|
+
},
|
|
419
|
+
"APPROVAL_PROCESS_NAME": {
|
|
420
|
+
"type": "string",
|
|
421
|
+
"description": "Path parameter: APPROVAL_PROCESS_NAME"
|
|
422
|
+
}
|
|
423
|
+
},
|
|
424
|
+
"required": [
|
|
425
|
+
"SOBJECT_API_NAME",
|
|
426
|
+
"APPROVAL_PROCESS_NAME"
|
|
427
|
+
]
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "sobject_compactlayouts",
|
|
432
|
+
"description": "Returns a list of compact layouts for a specific object. This resource is available in REST API version 29.0 and later.",
|
|
433
|
+
"method": "GET",
|
|
434
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe/describe/compactLayouts",
|
|
435
|
+
"urlKind": "versioned",
|
|
436
|
+
"inputSchema": {
|
|
437
|
+
"type": "object",
|
|
438
|
+
"properties": {
|
|
439
|
+
"SOBJECT_API_NAME": {
|
|
440
|
+
"type": "string",
|
|
441
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"required": [
|
|
445
|
+
"SOBJECT_API_NAME"
|
|
446
|
+
]
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "describe_global_layouts",
|
|
451
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
452
|
+
"method": "GET",
|
|
453
|
+
"path": "/sobjects/Global/describe/layouts/",
|
|
454
|
+
"urlKind": "versioned",
|
|
455
|
+
"inputSchema": {
|
|
456
|
+
"type": "object",
|
|
457
|
+
"properties": {},
|
|
458
|
+
"required": []
|
|
459
|
+
}
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "describe_sobject_layouts",
|
|
463
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
464
|
+
"method": "GET",
|
|
465
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe/layouts/",
|
|
466
|
+
"urlKind": "versioned",
|
|
467
|
+
"inputSchema": {
|
|
468
|
+
"type": "object",
|
|
469
|
+
"properties": {
|
|
470
|
+
"SOBJECT_API_NAME": {
|
|
471
|
+
"type": "string",
|
|
472
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"required": [
|
|
476
|
+
"SOBJECT_API_NAME"
|
|
477
|
+
]
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "describe_sobj_layouts_per_rt",
|
|
482
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
483
|
+
"method": "GET",
|
|
484
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/describe/layouts/{RECORD_TYPE_ID}",
|
|
485
|
+
"urlKind": "versioned",
|
|
486
|
+
"inputSchema": {
|
|
487
|
+
"type": "object",
|
|
488
|
+
"properties": {
|
|
489
|
+
"SOBJECT_API_NAME": {
|
|
490
|
+
"type": "string",
|
|
491
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
492
|
+
},
|
|
493
|
+
"RECORD_TYPE_ID": {
|
|
494
|
+
"type": "string",
|
|
495
|
+
"description": "Path parameter: RECORD_TYPE_ID"
|
|
496
|
+
}
|
|
497
|
+
},
|
|
498
|
+
"required": [
|
|
499
|
+
"SOBJECT_API_NAME",
|
|
500
|
+
"RECORD_TYPE_ID"
|
|
501
|
+
]
|
|
502
|
+
}
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "sobject_platformaction",
|
|
506
|
+
"description": "PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.\nReturns the description of the PlatformAction.",
|
|
507
|
+
"method": "GET",
|
|
508
|
+
"path": "/sobjects/PlatformAction",
|
|
509
|
+
"urlKind": "versioned",
|
|
510
|
+
"inputSchema": {
|
|
511
|
+
"type": "object",
|
|
512
|
+
"properties": {},
|
|
513
|
+
"required": []
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"name": "sobject_quick_actions",
|
|
518
|
+
"description": "Returns a list of actions and their details. This resource is available in REST API version 28.0 and later. When working with actions, also refer to Quick Actions.\n\nTo return a specific object’s actions as well as global actions, use: /vXX.X/sobjects/object/quickActions/\nTo return a specific action, use /vXX.X/sobjects/object/quickActions/{action name}\nTo return a specific action’s descriptive detail, use /vXX.X/sobjects/object/quickActions/{action name}/describe/\nTo return a specific action’s d",
|
|
519
|
+
"method": "GET",
|
|
520
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/quickActions/",
|
|
521
|
+
"urlKind": "versioned",
|
|
522
|
+
"inputSchema": {
|
|
523
|
+
"type": "object",
|
|
524
|
+
"properties": {
|
|
525
|
+
"SOBJECT_API_NAME": {
|
|
526
|
+
"type": "string",
|
|
527
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
528
|
+
}
|
|
529
|
+
},
|
|
530
|
+
"required": [
|
|
531
|
+
"SOBJECT_API_NAME"
|
|
532
|
+
]
|
|
533
|
+
}
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"name": "sobject_rich_text_image_retrieve",
|
|
537
|
+
"description": "Retrieves the specified image data from a specific rich text area field in a given record.\ncontentReferenceId\tThe reference ID that uniquely identifies an image within a rich text area field.\nYou can obtain the reference by retrieving information for the object. The description will show the contents of the rich text area field",
|
|
538
|
+
"method": "GET",
|
|
539
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/richTextImageFields/{FIELD_NAME}/{CONTENT_REFERENCE_ID}",
|
|
540
|
+
"urlKind": "versioned",
|
|
541
|
+
"inputSchema": {
|
|
542
|
+
"type": "object",
|
|
543
|
+
"properties": {
|
|
544
|
+
"SOBJECT_API_NAME": {
|
|
545
|
+
"type": "string",
|
|
546
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
547
|
+
},
|
|
548
|
+
"RECORD_ID": {
|
|
549
|
+
"type": "string",
|
|
550
|
+
"description": "Path parameter: RECORD_ID"
|
|
551
|
+
},
|
|
552
|
+
"FIELD_NAME": {
|
|
553
|
+
"type": "string",
|
|
554
|
+
"description": "Path parameter: FIELD_NAME"
|
|
555
|
+
},
|
|
556
|
+
"CONTENT_REFERENCE_ID": {
|
|
557
|
+
"type": "string",
|
|
558
|
+
"description": "Path parameter: CONTENT_REFERENCE_ID"
|
|
559
|
+
}
|
|
560
|
+
},
|
|
561
|
+
"required": [
|
|
562
|
+
"SOBJECT_API_NAME",
|
|
563
|
+
"RECORD_ID",
|
|
564
|
+
"FIELD_NAME",
|
|
565
|
+
"CONTENT_REFERENCE_ID"
|
|
566
|
+
]
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "sobject_relationships",
|
|
571
|
+
"description": "Accesses records by traversing object relationships via friendly URLs. You can retrieve, update, or delete the record associated with the traversed relationship field. If there are multiple related records, you can retrieve the complete set of associated records. This resource is available in REST API version 36.0 and later.\n\nGET, PATCH, DELETE",
|
|
572
|
+
"method": "GET",
|
|
573
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/{RELATIONSHIP_FIELD_NAME}",
|
|
574
|
+
"urlKind": "versioned",
|
|
575
|
+
"inputSchema": {
|
|
576
|
+
"type": "object",
|
|
577
|
+
"properties": {
|
|
578
|
+
"SOBJECT_API_NAME": {
|
|
579
|
+
"type": "string",
|
|
580
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
581
|
+
},
|
|
582
|
+
"RECORD_ID": {
|
|
583
|
+
"type": "string",
|
|
584
|
+
"description": "Path parameter: RECORD_ID"
|
|
585
|
+
},
|
|
586
|
+
"RELATIONSHIP_FIELD_NAME": {
|
|
587
|
+
"type": "string",
|
|
588
|
+
"description": "Path parameter: RELATIONSHIP_FIELD_NAME"
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
"required": [
|
|
592
|
+
"SOBJECT_API_NAME",
|
|
593
|
+
"RECORD_ID",
|
|
594
|
+
"RELATIONSHIP_FIELD_NAME"
|
|
595
|
+
]
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "sobject_suggested_articles",
|
|
600
|
+
"description": "Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item.",
|
|
601
|
+
"method": "GET",
|
|
602
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/suggestedArticles",
|
|
603
|
+
"urlKind": "versioned",
|
|
604
|
+
"inputSchema": {
|
|
605
|
+
"type": "object",
|
|
606
|
+
"properties": {
|
|
607
|
+
"SOBJECT_API_NAME": {
|
|
608
|
+
"type": "string",
|
|
609
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
610
|
+
},
|
|
611
|
+
"description": {
|
|
612
|
+
"type": "string",
|
|
613
|
+
"description": "Query: description"
|
|
614
|
+
},
|
|
615
|
+
"language": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"description": "Query: language"
|
|
618
|
+
},
|
|
619
|
+
"subject": {
|
|
620
|
+
"type": "string",
|
|
621
|
+
"description": "Query: subject"
|
|
622
|
+
}
|
|
623
|
+
},
|
|
624
|
+
"required": [
|
|
625
|
+
"SOBJECT_API_NAME"
|
|
626
|
+
]
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "sobject_user_password",
|
|
631
|
+
"description": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.",
|
|
632
|
+
"method": "GET",
|
|
633
|
+
"path": "/sobjects/User/{USER_ID}/password",
|
|
634
|
+
"urlKind": "versioned",
|
|
635
|
+
"inputSchema": {
|
|
636
|
+
"type": "object",
|
|
637
|
+
"properties": {
|
|
638
|
+
"USER_ID": {
|
|
639
|
+
"type": "string",
|
|
640
|
+
"description": "Path parameter: USER_ID"
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"required": [
|
|
644
|
+
"USER_ID"
|
|
645
|
+
]
|
|
646
|
+
}
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "sobject_self_service_user_password",
|
|
650
|
+
"description": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.",
|
|
651
|
+
"method": "GET",
|
|
652
|
+
"path": "/sobjects/SelfServiceUser/{USER_ID}/password",
|
|
653
|
+
"urlKind": "versioned",
|
|
654
|
+
"inputSchema": {
|
|
655
|
+
"type": "object",
|
|
656
|
+
"properties": {
|
|
657
|
+
"USER_ID": {
|
|
658
|
+
"type": "string",
|
|
659
|
+
"description": "Path parameter: USER_ID"
|
|
660
|
+
}
|
|
661
|
+
},
|
|
662
|
+
"required": [
|
|
663
|
+
"USER_ID"
|
|
664
|
+
]
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"name": "compact_layouts",
|
|
669
|
+
"description": "Returns a list of compact layouts for multiple objects. This resource is available in REST API version 31.0 and later.",
|
|
670
|
+
"method": "GET",
|
|
671
|
+
"path": "/compactLayouts",
|
|
672
|
+
"urlKind": "versioned",
|
|
673
|
+
"inputSchema": {
|
|
674
|
+
"type": "object",
|
|
675
|
+
"properties": {
|
|
676
|
+
"q": {
|
|
677
|
+
"type": "string",
|
|
678
|
+
"description": "object list"
|
|
679
|
+
}
|
|
680
|
+
},
|
|
681
|
+
"required": []
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"name": "request_openapi_schema",
|
|
686
|
+
"description": "Requests an Open API document for the selected SObject REST API resources.",
|
|
687
|
+
"method": "POST",
|
|
688
|
+
"path": "/async/specifications/oas3",
|
|
689
|
+
"urlKind": "versioned",
|
|
690
|
+
"inputSchema": {
|
|
691
|
+
"type": "object",
|
|
692
|
+
"properties": {},
|
|
693
|
+
"required": []
|
|
694
|
+
}
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"name": "retrieve_openapi_schema",
|
|
698
|
+
"description": "Generate an OpenAPI 3.0 document for the sObjects REST API. This is a [Beta feature](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/openapi_beta.htm) that requires an activation step before it can be used.",
|
|
699
|
+
"method": "GET",
|
|
700
|
+
"path": "/async/specifications/oas3/{schemaId}",
|
|
701
|
+
"urlKind": "versioned",
|
|
702
|
+
"inputSchema": {
|
|
703
|
+
"type": "object",
|
|
704
|
+
"properties": {
|
|
705
|
+
"schemaId": {
|
|
706
|
+
"type": "string",
|
|
707
|
+
"description": "Path parameter: schemaId"
|
|
708
|
+
}
|
|
709
|
+
},
|
|
710
|
+
"required": [
|
|
711
|
+
"schemaId"
|
|
712
|
+
]
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "lightning_toggle_metrics",
|
|
717
|
+
"description": "Return details about users who switched between Salesforce Classic and Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm",
|
|
718
|
+
"method": "GET",
|
|
719
|
+
"path": "/sobjects/LightningToggleMetrics",
|
|
720
|
+
"urlKind": "versioned",
|
|
721
|
+
"inputSchema": {
|
|
722
|
+
"type": "object",
|
|
723
|
+
"properties": {},
|
|
724
|
+
"required": []
|
|
725
|
+
}
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "lightning_usage_by_page",
|
|
729
|
+
"description": "Represents standard pages users viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm",
|
|
730
|
+
"method": "GET",
|
|
731
|
+
"path": "/sobjects/LightningUsageByBrowserMetrics",
|
|
732
|
+
"urlKind": "versioned",
|
|
733
|
+
"inputSchema": {
|
|
734
|
+
"type": "object",
|
|
735
|
+
"properties": {},
|
|
736
|
+
"required": []
|
|
737
|
+
}
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"name": "lightning_usage_by_app_type",
|
|
741
|
+
"description": "Return the total number of Lightning Experience and Salesforce Mobile users.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm",
|
|
742
|
+
"method": "GET",
|
|
743
|
+
"path": "/sobjects/LightningUsageByAppTypeMetrics",
|
|
744
|
+
"urlKind": "versioned",
|
|
745
|
+
"inputSchema": {
|
|
746
|
+
"type": "object",
|
|
747
|
+
"properties": {},
|
|
748
|
+
"required": []
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"name": "lightning_usage_by_flexipage",
|
|
753
|
+
"description": "Return details about the custom pages viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm",
|
|
754
|
+
"method": "GET",
|
|
755
|
+
"path": "/sobjects/LightningUsageByFlexiPageMetrics",
|
|
756
|
+
"urlKind": "versioned",
|
|
757
|
+
"inputSchema": {
|
|
758
|
+
"type": "object",
|
|
759
|
+
"properties": {},
|
|
760
|
+
"required": []
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"name": "lightning_exit_by_page_metrics",
|
|
765
|
+
"description": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm",
|
|
766
|
+
"method": "GET",
|
|
767
|
+
"path": "/sobjects/LightningExitByPageMetrics",
|
|
768
|
+
"urlKind": "versioned",
|
|
769
|
+
"inputSchema": {
|
|
770
|
+
"type": "object",
|
|
771
|
+
"properties": {},
|
|
772
|
+
"required": []
|
|
773
|
+
}
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "list_views",
|
|
777
|
+
"description": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.",
|
|
778
|
+
"method": "GET",
|
|
779
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/listviews/",
|
|
780
|
+
"urlKind": "versioned",
|
|
781
|
+
"inputSchema": {
|
|
782
|
+
"type": "object",
|
|
783
|
+
"properties": {
|
|
784
|
+
"SOBJECT_API_NAME": {
|
|
785
|
+
"type": "string",
|
|
786
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
787
|
+
}
|
|
788
|
+
},
|
|
789
|
+
"required": [
|
|
790
|
+
"SOBJECT_API_NAME"
|
|
791
|
+
]
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "list_view_describe",
|
|
796
|
+
"description": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query.",
|
|
797
|
+
"method": "GET",
|
|
798
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/listviews/{QUERY_LOCATOR}/describe",
|
|
799
|
+
"urlKind": "versioned",
|
|
800
|
+
"inputSchema": {
|
|
801
|
+
"type": "object",
|
|
802
|
+
"properties": {
|
|
803
|
+
"SOBJECT_API_NAME": {
|
|
804
|
+
"type": "string",
|
|
805
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
806
|
+
},
|
|
807
|
+
"QUERY_LOCATOR": {
|
|
808
|
+
"type": "string",
|
|
809
|
+
"description": "Path parameter: QUERY_LOCATOR"
|
|
810
|
+
}
|
|
811
|
+
},
|
|
812
|
+
"required": [
|
|
813
|
+
"SOBJECT_API_NAME",
|
|
814
|
+
"QUERY_LOCATOR"
|
|
815
|
+
]
|
|
816
|
+
}
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "list_view_results",
|
|
820
|
+
"description": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query.",
|
|
821
|
+
"method": "GET",
|
|
822
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/listviews/{LIST_VIEW_ID}/results",
|
|
823
|
+
"urlKind": "versioned",
|
|
824
|
+
"inputSchema": {
|
|
825
|
+
"type": "object",
|
|
826
|
+
"properties": {
|
|
827
|
+
"SOBJECT_API_NAME": {
|
|
828
|
+
"type": "string",
|
|
829
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
830
|
+
},
|
|
831
|
+
"LIST_VIEW_ID": {
|
|
832
|
+
"type": "string",
|
|
833
|
+
"description": "Path parameter: LIST_VIEW_ID"
|
|
834
|
+
}
|
|
835
|
+
},
|
|
836
|
+
"required": [
|
|
837
|
+
"SOBJECT_API_NAME",
|
|
838
|
+
"LIST_VIEW_ID"
|
|
839
|
+
]
|
|
840
|
+
}
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "recently_viewed_items",
|
|
844
|
+
"description": "Gets the most recently accessed items that were viewed or referenced by the current user. Salesforce stores information about record views in the interface and uses it to generate a list of recently viewed and referenced records, such as in the sidebar and for the auto-complete options in search.\n\nThis resource only accesses most recently used item information. If you want to modify the list of recently viewed items, you’ll need to update recently viewed information directly by using a SOQL Quer",
|
|
845
|
+
"method": "GET",
|
|
846
|
+
"path": "/sobjects/{SOBJECT_API_NAME}/listviews/recent",
|
|
847
|
+
"urlKind": "versioned",
|
|
848
|
+
"inputSchema": {
|
|
849
|
+
"type": "object",
|
|
850
|
+
"properties": {
|
|
851
|
+
"SOBJECT_API_NAME": {
|
|
852
|
+
"type": "string",
|
|
853
|
+
"description": "Path parameter: SOBJECT_API_NAME"
|
|
854
|
+
},
|
|
855
|
+
"limit": {
|
|
856
|
+
"type": "string",
|
|
857
|
+
"description": "Query: limit"
|
|
858
|
+
}
|
|
859
|
+
},
|
|
860
|
+
"required": [
|
|
861
|
+
"SOBJECT_API_NAME"
|
|
862
|
+
]
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"name": "get_event_logs",
|
|
867
|
+
"description": "Executes the specified SOQL query.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm",
|
|
868
|
+
"method": "GET",
|
|
869
|
+
"path": "/query/",
|
|
870
|
+
"urlKind": "versioned",
|
|
871
|
+
"inputSchema": {
|
|
872
|
+
"type": "object",
|
|
873
|
+
"properties": {
|
|
874
|
+
"q": {
|
|
875
|
+
"type": "string",
|
|
876
|
+
"description": "Gets the first 200 EventLogFile records ordered by most recently updated first."
|
|
877
|
+
}
|
|
878
|
+
},
|
|
879
|
+
"required": []
|
|
880
|
+
}
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "get_event_log_file",
|
|
884
|
+
"description": "Get event log file",
|
|
885
|
+
"method": "GET",
|
|
886
|
+
"path": "/sobjects/EventLogFile/{id}/LogFile",
|
|
887
|
+
"urlKind": "versioned",
|
|
888
|
+
"inputSchema": {
|
|
889
|
+
"type": "object",
|
|
890
|
+
"properties": {
|
|
891
|
+
"id": {
|
|
892
|
+
"type": "string",
|
|
893
|
+
"description": "Path parameter: id"
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
"required": [
|
|
897
|
+
"id"
|
|
898
|
+
]
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"name": "scheduling",
|
|
903
|
+
"description": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm",
|
|
904
|
+
"method": "GET",
|
|
905
|
+
"path": "/scheduling",
|
|
906
|
+
"urlKind": "versioned",
|
|
907
|
+
"inputSchema": {
|
|
908
|
+
"type": "object",
|
|
909
|
+
"properties": {},
|
|
910
|
+
"required": []
|
|
911
|
+
}
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"name": "get_appointment_slots",
|
|
915
|
+
"description": "Returns a list of available appointment time slots for a resource based on given work type group and territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentslots.htm",
|
|
916
|
+
"method": "POST",
|
|
917
|
+
"path": "/scheduling/getAppointmentSlots",
|
|
918
|
+
"urlKind": "versioned",
|
|
919
|
+
"inputSchema": {
|
|
920
|
+
"type": "object",
|
|
921
|
+
"properties": {},
|
|
922
|
+
"required": []
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "get_appointment_candidates",
|
|
927
|
+
"description": "Returns a list of available service resources (appointment candidates) based on work type group and service territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm",
|
|
928
|
+
"method": "POST",
|
|
929
|
+
"path": "/scheduling/getAppointmentCandidates",
|
|
930
|
+
"urlKind": "versioned",
|
|
931
|
+
"inputSchema": {
|
|
932
|
+
"type": "object",
|
|
933
|
+
"properties": {},
|
|
934
|
+
"required": []
|
|
935
|
+
}
|
|
936
|
+
},
|
|
937
|
+
{
|
|
938
|
+
"name": "search",
|
|
939
|
+
"description": "Executes the specified SOSL search. The search string must be URL-encoded.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm",
|
|
940
|
+
"method": "GET",
|
|
941
|
+
"path": "/search",
|
|
942
|
+
"urlKind": "versioned",
|
|
943
|
+
"inputSchema": {
|
|
944
|
+
"type": "object",
|
|
945
|
+
"properties": {
|
|
946
|
+
"q": {
|
|
947
|
+
"type": "string",
|
|
948
|
+
"description": "A SOSL statement that is properly URL-encoded."
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
"required": []
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
"name": "search_scope_and_order",
|
|
956
|
+
"description": "Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list.\nThe returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using",
|
|
957
|
+
"method": "GET",
|
|
958
|
+
"path": "/search/scopeOrder",
|
|
959
|
+
"urlKind": "versioned",
|
|
960
|
+
"inputSchema": {
|
|
961
|
+
"type": "object",
|
|
962
|
+
"properties": {},
|
|
963
|
+
"required": []
|
|
964
|
+
}
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "search_result_layouts",
|
|
968
|
+
"description": "Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page.\nThis call supports bulk fetch for up to 100 objects in a query.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm",
|
|
969
|
+
"method": "GET",
|
|
970
|
+
"path": "/search/layout/",
|
|
971
|
+
"urlKind": "versioned",
|
|
972
|
+
"inputSchema": {
|
|
973
|
+
"type": "object",
|
|
974
|
+
"properties": {
|
|
975
|
+
"q": {
|
|
976
|
+
"type": "string",
|
|
977
|
+
"description": "Comma delimited object list"
|
|
978
|
+
}
|
|
979
|
+
},
|
|
980
|
+
"required": []
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "get_search_suggestions",
|
|
985
|
+
"description": "Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm",
|
|
986
|
+
"method": "GET",
|
|
987
|
+
"path": "/search/suggestions",
|
|
988
|
+
"urlKind": "versioned",
|
|
989
|
+
"inputSchema": {
|
|
990
|
+
"type": "object",
|
|
991
|
+
"properties": {
|
|
992
|
+
"q": {
|
|
993
|
+
"type": "string",
|
|
994
|
+
"description": "Query: q"
|
|
995
|
+
},
|
|
996
|
+
"sobject": {
|
|
997
|
+
"type": "string",
|
|
998
|
+
"description": "Query: sobject"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
"required": []
|
|
1002
|
+
}
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "search_suggested_queries",
|
|
1006
|
+
"description": "Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm",
|
|
1007
|
+
"method": "GET",
|
|
1008
|
+
"path": "/search/suggestSearchQueries",
|
|
1009
|
+
"urlKind": "versioned",
|
|
1010
|
+
"inputSchema": {
|
|
1011
|
+
"type": "object",
|
|
1012
|
+
"properties": {
|
|
1013
|
+
"q": {
|
|
1014
|
+
"type": "string",
|
|
1015
|
+
"description": "Query: q"
|
|
1016
|
+
},
|
|
1017
|
+
"language": {
|
|
1018
|
+
"type": "string",
|
|
1019
|
+
"description": "Query: language"
|
|
1020
|
+
}
|
|
1021
|
+
},
|
|
1022
|
+
"required": []
|
|
1023
|
+
}
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"name": "parameterized_search",
|
|
1027
|
+
"description": "Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches.",
|
|
1028
|
+
"method": "GET",
|
|
1029
|
+
"path": "/parameterizedSearch/",
|
|
1030
|
+
"urlKind": "versioned",
|
|
1031
|
+
"inputSchema": {
|
|
1032
|
+
"type": "object",
|
|
1033
|
+
"properties": {
|
|
1034
|
+
"q": {
|
|
1035
|
+
"type": "string",
|
|
1036
|
+
"description": "A search string that is properly URL-encoded"
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
1039
|
+
"required": []
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "relevant_items",
|
|
1044
|
+
"description": "Gets the current user’s most relevant items. Relevant items include records for objects in the user’s global search scope and also most recently used (MRU) objects.\nRelevant items include up to 50 of the most recently viewed or updated records for each object in the user’s global search scope.\nNote\nThe user’s global search scope includes the objects the user interacted with most in the last 30 days, including objects the user pinned from the search results page in the Salesforce Classic.\n\nThen, ",
|
|
1045
|
+
"method": "GET",
|
|
1046
|
+
"path": "/sobjects/relevantItems",
|
|
1047
|
+
"urlKind": "versioned",
|
|
1048
|
+
"inputSchema": {
|
|
1049
|
+
"type": "object",
|
|
1050
|
+
"properties": {},
|
|
1051
|
+
"required": []
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "process_approvals",
|
|
1056
|
+
"description": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm",
|
|
1057
|
+
"method": "GET",
|
|
1058
|
+
"path": "/process/approvals",
|
|
1059
|
+
"urlKind": "versioned",
|
|
1060
|
+
"inputSchema": {
|
|
1061
|
+
"type": "object",
|
|
1062
|
+
"properties": {},
|
|
1063
|
+
"required": []
|
|
1064
|
+
}
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "process_approvals_submit",
|
|
1068
|
+
"description": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm",
|
|
1069
|
+
"method": "POST",
|
|
1070
|
+
"path": "/process/approvals",
|
|
1071
|
+
"urlKind": "versioned",
|
|
1072
|
+
"inputSchema": {
|
|
1073
|
+
"type": "object",
|
|
1074
|
+
"properties": {},
|
|
1075
|
+
"required": []
|
|
1076
|
+
}
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "process_rules",
|
|
1080
|
+
"description": "Returns a list of all active workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. When using a POST request, if anything fails, the whole transaction is rolled back.\n\nCross-object workflow rules cannot be invoked using the REST API.\n\nTo get a list of the workflow rules or to trigger one or more workflow rules",
|
|
1081
|
+
"method": "GET",
|
|
1082
|
+
"path": "/process/rules",
|
|
1083
|
+
"urlKind": "versioned",
|
|
1084
|
+
"inputSchema": {
|
|
1085
|
+
"type": "object",
|
|
1086
|
+
"properties": {},
|
|
1087
|
+
"required": []
|
|
1088
|
+
}
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"name": "emb_svc_config_describe",
|
|
1092
|
+
"description": "Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.\n\nYou must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.",
|
|
1093
|
+
"method": "GET",
|
|
1094
|
+
"path": "/support/embeddedservice/configuration/{EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME}",
|
|
1095
|
+
"urlKind": "versioned",
|
|
1096
|
+
"inputSchema": {
|
|
1097
|
+
"type": "object",
|
|
1098
|
+
"properties": {
|
|
1099
|
+
"EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"description": "Path parameter: EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME"
|
|
1102
|
+
}
|
|
1103
|
+
},
|
|
1104
|
+
"required": [
|
|
1105
|
+
"EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME"
|
|
1106
|
+
]
|
|
1107
|
+
}
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
"name": "data_category_groups",
|
|
1111
|
+
"description": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.",
|
|
1112
|
+
"method": "GET",
|
|
1113
|
+
"path": "/support/dataCategoryGroups",
|
|
1114
|
+
"urlKind": "versioned",
|
|
1115
|
+
"inputSchema": {
|
|
1116
|
+
"type": "object",
|
|
1117
|
+
"properties": {
|
|
1118
|
+
"sObjectName": {
|
|
1119
|
+
"type": "string",
|
|
1120
|
+
"description": "Query: sObjectName"
|
|
1121
|
+
}
|
|
1122
|
+
},
|
|
1123
|
+
"required": []
|
|
1124
|
+
}
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "data_category_detail",
|
|
1128
|
+
"description": "Get data category details and the child categories by a given category.",
|
|
1129
|
+
"method": "GET",
|
|
1130
|
+
"path": "/support/dataCategoryGroups/{GROUP}/dataCategories/{CATEGORY}",
|
|
1131
|
+
"urlKind": "versioned",
|
|
1132
|
+
"inputSchema": {
|
|
1133
|
+
"type": "object",
|
|
1134
|
+
"properties": {
|
|
1135
|
+
"GROUP": {
|
|
1136
|
+
"type": "string",
|
|
1137
|
+
"description": "Path parameter: GROUP"
|
|
1138
|
+
},
|
|
1139
|
+
"CATEGORY": {
|
|
1140
|
+
"type": "string",
|
|
1141
|
+
"description": "Path parameter: CATEGORY"
|
|
1142
|
+
}
|
|
1143
|
+
},
|
|
1144
|
+
"required": [
|
|
1145
|
+
"GROUP",
|
|
1146
|
+
"CATEGORY"
|
|
1147
|
+
]
|
|
1148
|
+
}
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "articles_list",
|
|
1152
|
+
"description": "Get a page of online articles for the given language and category through either search or query.",
|
|
1153
|
+
"method": "GET",
|
|
1154
|
+
"path": "/support/knowledgeArticles",
|
|
1155
|
+
"urlKind": "versioned",
|
|
1156
|
+
"inputSchema": {
|
|
1157
|
+
"type": "object",
|
|
1158
|
+
"properties": {},
|
|
1159
|
+
"required": []
|
|
1160
|
+
}
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
"name": "articles_details",
|
|
1164
|
+
"description": "Get all online article fields, accessible to the user.",
|
|
1165
|
+
"method": "GET",
|
|
1166
|
+
"path": "/support/knowledgeArticles/{ARTICLE_ID}",
|
|
1167
|
+
"urlKind": "versioned",
|
|
1168
|
+
"inputSchema": {
|
|
1169
|
+
"type": "object",
|
|
1170
|
+
"properties": {
|
|
1171
|
+
"ARTICLE_ID": {
|
|
1172
|
+
"type": "string",
|
|
1173
|
+
"description": "Path parameter: ARTICLE_ID"
|
|
1174
|
+
}
|
|
1175
|
+
},
|
|
1176
|
+
"required": [
|
|
1177
|
+
"ARTICLE_ID"
|
|
1178
|
+
]
|
|
1179
|
+
}
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"name": "retrieve_knowledge_language_settings",
|
|
1183
|
+
"description": "Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_knowledge_retrieve_language.htm",
|
|
1184
|
+
"method": "GET",
|
|
1185
|
+
"path": "/knowledgeManagement/settings",
|
|
1186
|
+
"urlKind": "versioned",
|
|
1187
|
+
"inputSchema": {
|
|
1188
|
+
"type": "object",
|
|
1189
|
+
"properties": {},
|
|
1190
|
+
"required": []
|
|
1191
|
+
}
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "apex_rest",
|
|
1195
|
+
"description": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/",
|
|
1196
|
+
"method": "GET",
|
|
1197
|
+
"path": "/{urlMapping}",
|
|
1198
|
+
"urlKind": "apex",
|
|
1199
|
+
"inputSchema": {
|
|
1200
|
+
"type": "object",
|
|
1201
|
+
"properties": {
|
|
1202
|
+
"urlMapping": {
|
|
1203
|
+
"type": "string",
|
|
1204
|
+
"description": "Path parameter: urlMapping"
|
|
1205
|
+
}
|
|
1206
|
+
},
|
|
1207
|
+
"required": [
|
|
1208
|
+
"urlMapping"
|
|
1209
|
+
]
|
|
1210
|
+
}
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"name": "versions",
|
|
1214
|
+
"description": "Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root.",
|
|
1215
|
+
"method": "GET",
|
|
1216
|
+
"path": "/",
|
|
1217
|
+
"urlKind": "data-catalog",
|
|
1218
|
+
"inputSchema": {
|
|
1219
|
+
"type": "object",
|
|
1220
|
+
"properties": {},
|
|
1221
|
+
"required": []
|
|
1222
|
+
}
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "resources_by_version",
|
|
1226
|
+
"description": "Lists available resources for the specified API version, including resource name and URI.",
|
|
1227
|
+
"method": "GET",
|
|
1228
|
+
"path": "/",
|
|
1229
|
+
"urlKind": "versioned",
|
|
1230
|
+
"inputSchema": {
|
|
1231
|
+
"type": "object",
|
|
1232
|
+
"properties": {},
|
|
1233
|
+
"required": []
|
|
1234
|
+
}
|
|
1235
|
+
},
|
|
1236
|
+
{
|
|
1237
|
+
"name": "limits",
|
|
1238
|
+
"description": "Lists information about limits in your org. For each limit, this resource returns the maximum allocation and the remaining allocation based on usage. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission",
|
|
1239
|
+
"method": "GET",
|
|
1240
|
+
"path": "/limits",
|
|
1241
|
+
"urlKind": "versioned",
|
|
1242
|
+
"inputSchema": {
|
|
1243
|
+
"type": "object",
|
|
1244
|
+
"properties": {},
|
|
1245
|
+
"required": []
|
|
1246
|
+
}
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "appmenu",
|
|
1250
|
+
"description": "Returns a list of items in either the Salesforce app drop-down menu or the Salesforce for Android, iOS, and mobile web navigation menu.",
|
|
1251
|
+
"method": "GET",
|
|
1252
|
+
"path": "/appMenu/",
|
|
1253
|
+
"urlKind": "versioned",
|
|
1254
|
+
"inputSchema": {
|
|
1255
|
+
"type": "object",
|
|
1256
|
+
"properties": {},
|
|
1257
|
+
"required": []
|
|
1258
|
+
}
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "consent",
|
|
1262
|
+
"description": "Your users can store consent preferences in different locations and possibly inconsistently. You can locate your customers’ preferences for consent across multiple records when using API version 44.0 and later. Tracking consent preferences helps you and your users respect the most restrictive requests.\nConsent API aggregates consent settings across the Contact, Contact Point Type Consent, Data Use Purpose, Individual, Lead, Person Account, and User objects when the records have a lookup relation",
|
|
1263
|
+
"method": "GET",
|
|
1264
|
+
"path": "/consent/action/action",
|
|
1265
|
+
"urlKind": "versioned",
|
|
1266
|
+
"inputSchema": {
|
|
1267
|
+
"type": "object",
|
|
1268
|
+
"properties": {
|
|
1269
|
+
"actions": {
|
|
1270
|
+
"type": "string",
|
|
1271
|
+
"description": "Query: actions"
|
|
1272
|
+
},
|
|
1273
|
+
"ids": {
|
|
1274
|
+
"type": "string",
|
|
1275
|
+
"description": "Query: ids"
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1278
|
+
"required": []
|
|
1279
|
+
}
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"name": "product_schedules",
|
|
1283
|
+
"description": "Work with revenue and quantity schedules for opportunity products. Establish or reestablish a product schedule with multiple installments for an opportunity product. Delete all installments in a schedule.\nThis resource is available in REST API version 43.0 and later.\n\nIn API version 46.0 and later, established and re-established schedules support custom fields, validation rules, and Apex triggers. Deleting all schedules now also fires delete triggers.\nhttps://developer.salesforce.com/docs/atlas.",
|
|
1284
|
+
"method": "GET",
|
|
1285
|
+
"path": "/sobjects/OpportunityLineItem/{OPPORTUNITY_LINE_ITEM_ID}/OpportunityLineItemSchedules",
|
|
1286
|
+
"urlKind": "versioned",
|
|
1287
|
+
"inputSchema": {
|
|
1288
|
+
"type": "object",
|
|
1289
|
+
"properties": {
|
|
1290
|
+
"OPPORTUNITY_LINE_ITEM_ID": {
|
|
1291
|
+
"type": "string",
|
|
1292
|
+
"description": "Path parameter: OPPORTUNITY_LINE_ITEM_ID"
|
|
1293
|
+
}
|
|
1294
|
+
},
|
|
1295
|
+
"required": [
|
|
1296
|
+
"OPPORTUNITY_LINE_ITEM_ID"
|
|
1297
|
+
]
|
|
1298
|
+
}
|
|
1299
|
+
},
|
|
1300
|
+
{
|
|
1301
|
+
"name": "queryall",
|
|
1302
|
+
"description": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next",
|
|
1303
|
+
"method": "GET",
|
|
1304
|
+
"path": "/queryAll/",
|
|
1305
|
+
"urlKind": "versioned",
|
|
1306
|
+
"inputSchema": {
|
|
1307
|
+
"type": "object",
|
|
1308
|
+
"properties": {
|
|
1309
|
+
"q": {
|
|
1310
|
+
"type": "string",
|
|
1311
|
+
"description": "Query: q"
|
|
1312
|
+
}
|
|
1313
|
+
},
|
|
1314
|
+
"required": []
|
|
1315
|
+
}
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
"name": "record_count",
|
|
1319
|
+
"description": "Lists information about object record counts in your organization.\nThis resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:\n\nDeleted records in the recycle bin.\nArchived records.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm",
|
|
1320
|
+
"method": "GET",
|
|
1321
|
+
"path": "/limits/recordCount",
|
|
1322
|
+
"urlKind": "versioned",
|
|
1323
|
+
"inputSchema": {
|
|
1324
|
+
"type": "object",
|
|
1325
|
+
"properties": {
|
|
1326
|
+
"sObjects": {
|
|
1327
|
+
"type": "string",
|
|
1328
|
+
"description": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org."
|
|
1329
|
+
}
|
|
1330
|
+
},
|
|
1331
|
+
"required": []
|
|
1332
|
+
}
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "tabs",
|
|
1336
|
+
"description": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm",
|
|
1337
|
+
"method": "GET",
|
|
1338
|
+
"path": "/tabs",
|
|
1339
|
+
"urlKind": "versioned",
|
|
1340
|
+
"inputSchema": {
|
|
1341
|
+
"type": "object",
|
|
1342
|
+
"properties": {},
|
|
1343
|
+
"required": []
|
|
1344
|
+
}
|
|
1345
|
+
},
|
|
1346
|
+
{
|
|
1347
|
+
"name": "themes",
|
|
1348
|
+
"description": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/",
|
|
1349
|
+
"method": "GET",
|
|
1350
|
+
"path": "/theme",
|
|
1351
|
+
"urlKind": "versioned",
|
|
1352
|
+
"inputSchema": {
|
|
1353
|
+
"type": "object",
|
|
1354
|
+
"properties": {},
|
|
1355
|
+
"required": []
|
|
1356
|
+
}
|
|
1357
|
+
}
|
|
1358
|
+
]
|
|
1359
|
+
}
|