Domains

The OpenGate API query allows to obtain the available domains provisioned under the domain of the user that sends the request.

URL

Type of Information URL

Domains provisioned in the platform

/north/v80/search/domains

Summary of the Domains provisioned in the platform

/north/v80/search/domains/summary

URL parameters

Using summary parameter in the URL request, "/north/v80/search/domains?summary=<value>" where <value> can be:

  • true: The response includes the summary object.

  • false (default): The same behavior when the parameter is not present. The summary object is not included in the response

Applicable Filter Fields

Table 1. Filter fields for searching Catalogued domains
Field name field name in where clause type

name

name of the domain

string

description

description of the domain

string

parentDomain

parentDomain name of the domain

string

Summary Information

Table 2. Summary common structure
Entity Constraint

count (field)

number of occurrences found in the whole search

Domain Object

See Domain Object Structure

The parameter parentDomain is not returned in the response of the search

Examples

An example of response could be something like this

Example 1. Operation Info as JSON (/north/v80/search/domains without summary parameter)
{
    "domains": [
        {
            "name": "Domain_1_1",
            "description": "Domain description"
        },
        {
            "name": "Domain_1_1_2",
            "description": "Domain description"
        }
    ]
}
Example 2. Operation Info as JSON (/north/v80/search/domains?summary=true)
{
    "page":{
        "number":1,
        "of":1
    },
    "summary": {
        "count": 2
    },
    "domains": [
        {
            "name": "Domain_1_1",
            "description": "Domain description"
        },
        {
            "name": "Domain_1_1_2",
            "description": "Domain description"
        }
    ]
}
Example 3. Operation Info as JSON (/north/v80/search/domains/summary)
{
    "summary": {
        "count": 2
    }
}