/api/domains/:id
Loads details about domain specified by ID.
This resource is fully available for Global and domain administrators. The domain parameters with turned-on the "visible for non-admin users" toogle are available to read for non-admin users.
Resource Information
Resource URL | |
---|---|
HTTP Method | GET |
Request Parameters
Parameters | Detail | Example |
---|---|---|
id | ID of the domain to fetch. You can find the ID in the response to | 123 |
showParametersFlags | Boolean parameter. If it is true, the returned JSON will contain the flag nonAdminUserVisible for each parameter. Default if false | false |
Response Structure
JSON response contains one JSON object with following elements:
Name | Description |
---|---|
id | Domain identifier |
name | Domain name |
description | Domain description |
active | Boolean flag indicating if domain is active |
dateFormat | Domain date format - default: "M/d/yyyy" |
timeFormat | Domain time format - default: "h:mm:ss a" |
timeZone | Domain time zone |
parameters | An array containing all additional parameters |
For parameters is defined the following structure:
Name | Description |
---|---|
parameter-name | Parameter name |
nonAdminUserVisible | Boolean flag indicating if the non-admin users are able to view the flag. Returned if showParametersFlags = true only |
Sample Request / Response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/domains/123?showParametersFlags=true
The JSON format response:
{ "id": "123", "name": "My Domain", "description": "This is my domain description", "active": true, "dateFormat": "yyyy-MM-dd", "timeFormat": "hh:mm:ss", "timeZone": "Asia/Hong_Kong", "parameters": [ { "myKey1": "myValue1" "nonAdminUserVisible": true }, { "myKey2": null "nonAdminUserVisible": false } ] }
Overview
Content Tools