Retrieves resources available for adding to a custom group

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns managed resources (computers or users) that can be added as members to a custom group, filtered by group type, category, domain, and search text. Supports pagination and sorting. Use the returned resourceId values in the resourceIds array when calling Create Static CG, Create Static Unique CG, Update Static CG, or Update Static Unique CG. Non-admin users cannot fetch user-type or static-unique category resources.

Request URL

https://{serverurl}/api/1.4/customgroup/availableResources

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

Must be application/json. Request body must be valid JSON.

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Must be application/json. Only JSON responses are supported.

- Request Body

application/json
JSON object
Hide Sub-Attributes
groupCategorystringMandatory

Target group category: '1'=Static, '2'=Dynamic, '5'=Static Unique.

groupTypestringMandatory

Target group type: '1'=Computers, '2'=Users.

domainFilterarrayOptional

Domain NetBIOS names to restrict results (e.g., ['CORP','BRANCH1']). Omit for all domains.

charFilterstringOptional

Text filter on resource name — only matching resources returned.

rangeIndexlongOptional

Page number (1-based). Default: 1.

limitstringOptional

Max resources per page. Default: 30.

sortOrderstringOptional

Sort direction: 'ASC' (A-Z) or 'DESC' (Z-A), case-insensitive. Default: ASC.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/1.4/customgroup/availableResources \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"groupType":"1","groupCategory":"1"}'
Show full

Sample Request Body

Fetch static computer resources filtered by two domains and name prefix.

Copied!
  {
    "groupType": "1",
    "rangeIndex": "1",
    "groupCategory": "1",
    "charFilter": "SRV",
    "sortOrder": "ASC",
    "limit": "30",
    "domainFilter": [
      "CORP",
      "BRANCH1"
    ]
  }
                
Show full

Fetch all available computer resources with only required fields.

Copied!
  {
    "groupType": "1",
    "groupCategory": "1"
  }
                
Show full

Fetch available user resources for a static user group.

Copied!
  {
    "groupType": "2",
    "rangeIndex": "1",
    "groupCategory": "1",
    "limit": "50",
    "domainFilter": [
      "CORP"
    ]
  }
                
Show full

Fetch resources for a static unique computer group.

Copied!
  {
    "groupType": "1",
    "rangeIndex": "1",
    "groupCategory": "5",
    "limit": "50",
    "domainFilter": [
      "CORP"
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'availableResources' for this endpoint.

message_responseJSON object

Response payload container.

Show Sub-Attributes
availableresourcesJSON object

Response payload.

Show Sub-Attributes
*JSON object

Map keyed by resource ID (string). Empty object {} when no resources match.

Show Sub-Attributes
resourceIdlong

Unique resource ID — use in resourceIds array when calling Create Static CG, Create Static Unique CG, Update Static CG, or Update Static Unique CG.

namestring

Display name: computer hostname or AD username.

domainNamestring

NetBIOS domain the resource belongs to.

osPlatformstring

[Computer groups only] OS platform identifier (e.g., 1=Windows, 2=Mac, 3=Linux). Absent for user groups.

message_versionstring

API version: '1.4'.

statusstring

'success' when the request completed without errors.

- HTTP code 500

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'availableResources' for this endpoint.

message_versionstring

API version: '1.4'.

statusstring

Always 'error' for error responses.

error_codestring

Internal error code: '1003' (INTERNAL_ERROR).

error_descriptionstring

Resolved I18N message, typically: An internal error occurred while processing the request.

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Computer resources keyed by resource ID with name, domain, and type.

Copied!
  {
    "message_type": "availableResources",
    "message_response": {
      "availableresources": {
        "101": {
          "resourceId": 101,
          "domainName": "CORP",
          "name": "SRV-DC01",
          "osPlatform": "1"
        },
        "102": {
          "resourceId": 102,
          "domainName": "CORP",
          "name": "SRV-APP01",
          "osPlatform": "1"
        },
        "201": {
          "resourceId": 201,
          "domainName": "BRANCH1",
          "name": "SRV-FILE01",
          "osPlatform": "1"
        }
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

User resources keyed by resource ID for a user group.

Copied!
  {
    "message_type": "availableResources",
    "message_response": {
      "availableresources": {
        "501": {
          "resourceId": 501,
          "domainName": "CORP",
          "name": "jsmith"
        },
        "502": {
          "resourceId": 502,
          "domainName": "CORP",
          "name": "mjones"
        }
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

No resources match the specified filters.

Copied!
  {
    "message_type": "availableResources",
    "message_response": {
      "availableresources": {}
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 500

Unexpected server-side failure retrieving resources.

Copied!
  {
    "error_description": "An internal error occurred while processing the request.",
    "message_type": "availableResources",
    "error_code": "1003",
    "message_version": "1.4",
    "status": "error"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.