/api/domains
Lists all domains.
This resource is available only for Global admin and only in multi-domain configurations.
Resource Information
Resource URL | |
---|---|
HTTP Method | GET |
Request Parameters
None.
Response Structure
JSON response contains array "domains" that contains multiple domain objects with following definition:
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 | Array containing all additional parameters |
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
The JSON format response:
{ "domains": [ { "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": [] }, { "id": "345", "name": "Second Domain", "description": "Another description", "active": fa;se, "dateFormat": null, "timeFormat": null, "timeZone": null, "parameters": [] } ] }
Overview
Content Tools