Stay organized with collections
Save and categorize content based on your preferences.
Lists rulesets.
HTTP request
GET https://contentwarehouse.googleapis.com/v1/{parent}/ruleSets
Path parameters
Parameters
parent
string
Required. The parent, which owns this collection of document. Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.
Query parameters
Parameters
pageSize
integer
The maximum number of rule sets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
A page token, received from a previous ruleSets.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ruleSets.list must match the call that provided the page token.
Request body
The request body must be empty.
Response body
Response message for RuleSetService.ListRuleSets.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis API endpoint lists rule sets within a specified project and location using a \u003ccode\u003eGET\u003c/code\u003e request to \u003ccode\u003ehttps://contentwarehouse.googleapis.com/v1/{parent}/ruleSets\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required to specify the project and location in the format \u003ccode\u003eprojects/{projectNumber}/locations/{location}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can control the number of rule sets returned using the \u003ccode\u003epageSize\u003c/code\u003e query parameter, with a maximum of 1000, and if not specified, the default is 50 rule sets.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epageToken\u003c/code\u003e query parameter allows for pagination through the results, retrieving subsequent pages of rule sets.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this endpoint requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003econtentwarehouse.ruleSets.list\u003c/code\u003e on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.ruleSets.list\n\nLists rulesets.\n\n### HTTP request\n\n`GET https://contentwarehouse.googleapis.com/v1/{parent}/ruleSets`\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for RuleSetService.ListRuleSets.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `contentwarehouse.ruleSets.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]