For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd one or more components to project
        • POSTCreate a new component group document
        • POSTCreate a new project
        • POSTCreate a new template document
        • POSTCreate a new workflow document
        • DELDelete a component group document
        • DELDelete a project and any components it contains
        • DELDelete a template document
        • POSTDiscover referenced resources
        • GETExport a template document
        • GETExport project as JSON document
        • GETGet a list of all the apps and adapters
        • GETGet a page of component group documents
        • GETGet a page of template documents
        • GETGet a page of workflow documents
        • GETGet a project's thumbnail
        • GETGet component group document
        • GETGet details of a workflow
        • GETGet project
        • GETGet references to a particular document
        • GETGet task details
        • POSTGet task details
        • GETGet template document
        • POSTImport a new component group document
        • POSTImport a new template document
        • POSTImport a new workflow document
        • POSTImport a project document from a JSON document
        • GETList all available rest calls
        • DELRemove a component from a project
        • PUTReplace a component group document
        • PUTReplace a template document
        • PUTReplace a workflow document
        • GETSearch projects
        • PUTSet a project's thumbnail image
        • PATCHUpdate an existing project
        • POSTValidate a workflow
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAutomation Studio

Get a page of component group documents

GET
http://localhost:3000/automation-studio/component-groups
GET
/automation-studio/component-groups
$curl http://localhost:3000/automation-studio/component-groups \
>     -u "<username>:<password>"
1{
2  "items": [
3    {
4      "name": "Infoblox Workflows",
5      "gbacRead": [
6        "CAcFAfEa9aCe7ba08d482B3F"
7      ],
8      "members": [
9        {
10          "path": [
11            "Assign Next IP - Infoblox"
12          ],
13          "type": "folder"
14        }
15      ],
16      "_id": "string",
17      "description": "Infoblox Workflows",
18      "gbacWrite": [
19        "CAcFAfEa9aCe7ba08d482B3F"
20      ],
21      "version": 1,
22      "meta": {}
23    }
24  ],
25  "total": 100,
26  "start": 0,
27  "end": 100,
28  "count": 100,
29  "next": "string",
30  "previous": "string"
31}
Returns a page of component group documents.
Was this page helpful?
Previous

Get a page of template documents

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

limitintegerOptional>=0Defaults to 25
Number of results to return. Used for pagination.
skipintegerOptional>=0Defaults to 0
Number of results to skip. Used for pagination.
orderenumOptionalDefaults to 1

Sort direction, 1 for ascending and -1 for descending.

Allowed values:
sortenumOptionalDefaults to name
Field to sort by
Allowed values:
includestringOptional

Inclusive projection operator formatted as a comma-delineated list. ‘_id’ will be included implicitly unless excluded with ‘exclude=_id’. May only be used in conjunction with ‘exclude’ when ‘exclude=_id’.

excludestringOptional

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with ‘include’ when ‘exclude=_id’.

instringOptional
Search for fields exactly matching one of the given list options
not-instringOptional
Search for fields not exactly matching one of the given list options
equalsstringOptional

Returns results where the specified fields exactly match the given match string(s).

containsstringOptional

Returns results where the specified fields contain the given match string(s).

starts-withstringOptional

Returns results where the specified fields start with the given match string(s).

ends-withstringOptional

Returns results where the specified fields end in the given match string(s).

Response

Results for the given search parameters.
itemslist of objects
totalinteger
Total number of documents matching the given query parameters.
startinteger
Search index of first document in the items array.
endinteger
Search index of the last document in the items array.
countinteger
Length of the items array.
nextstring or null
URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.
previousstring or null
URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.

Errors

500
Internal Server Error