Skip to content

Commit 5817ced

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2024/03/15
1 parent 2a7b6f1 commit 5817ced

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed
+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
{
2+
"group": "apps",
3+
"name": "apps.datastore.count",
4+
"deprecated": false,
5+
"desc": "Count the number of items in a datastore that match a query",
6+
"args": {
7+
"datastore": {
8+
"required": true,
9+
"desc": "Name of the datastore.",
10+
"type": "string"
11+
},
12+
"app_id": {
13+
"required": false,
14+
"desc": "Required if calling with user token."
15+
},
16+
"expression": {
17+
"required": false,
18+
"example": "#artist = :artist_name",
19+
"desc": "A query filter expression https://api.slack.com/future/datastores.",
20+
"type": "string"
21+
},
22+
"expression_attributes": {
23+
"required": false,
24+
"example": "{ \"#artist\": \"artist\" }",
25+
"desc": "A map of attributes referenced in expression.",
26+
"type": "object"
27+
},
28+
"expression_values": {
29+
"required": false,
30+
"example": "{ \":artist_name\": \"Fred Rogers\" }",
31+
"desc": "A map of values referenced in expression.",
32+
"type": "object"
33+
}
34+
},
35+
"response": {
36+
"examples": [
37+
"{\n \"ok\": true,\n \"datastore\": \"good_tunes\",\n \"count\": 2\n}",
38+
"{\n \"ok\": false,\n \"error\": \"datastore_error\",\n \"errors\": [\n {\n \"code\": \"datastore_config_not_found\",\n \"message\": \"The datastore configuration could not be found\",\n \"pointer\": \"/datastores\"\n }\n ]\n}"
39+
]
40+
},
41+
"errors": {
42+
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.",
43+
"invalid_datastore": "The provided datastore is invalid.",
44+
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
45+
"app_not_hosted": "The app developer is not using a Slack-hosted environment. App datastores are exclusively available for Slack-hosted apps.",
46+
"datastore_error": "Datastore error.",
47+
"access_denied": "Access to a resource specified in the request is denied.",
48+
"invalid_app_id": "The app_id provided is not valid for team and user.",
49+
"free_team_not_allowed": "Datastore query not allowed on a free team.",
50+
"team_quota_exceeded": "Total number of requests exceeded team quota.",
51+
"datastore_migration_in_progress": "The datastore is currently unavailable due to an in progress Enterprise Grid migration.",
52+
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
53+
"deprecated_endpoint": "The endpoint has been deprecated.",
54+
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
55+
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
56+
"is_bot": "This method cannot be called by a legacy bot.",
57+
"method_deprecated": "The method has been deprecated.",
58+
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
59+
"not_allowed_token_type": "The token type used in this request is not allowed.",
60+
"not_authed": "No authentication token provided.",
61+
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
62+
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
63+
"token_expired": "Authentication token has expired.",
64+
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
65+
"two_factor_setup_required": "Two factor setup is required.",
66+
"accesslimited": "Access to this method is limited on the current network.",
67+
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
68+
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
69+
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
70+
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
71+
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
72+
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
73+
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
74+
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
75+
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
76+
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
77+
"service_unavailable": "The service is temporarily unavailable.",
78+
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete."
79+
}
80+
}

0 commit comments

Comments
 (0)