Versions Compared

Old Version 12

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version Current

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

/api/domains/:id

Loads details about domain specified by ID.

Note

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

https://service.belladati.com/api/domains/:id

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the domain to fetch. You can find the ID in the response to /api/domains.

123
showParametersFlagsBoolean parameter. If it is true, the returned JSON will contain the flag nonAdminUserVisible for each parameter. Default if falsefalse

Response Structure

JSON response contains one JSON object with following elements:

NameDescription
idDomain identifier
nameDomain name
descriptionDomain description
activeBoolean flag indicating if domain is active
dateFormatDomain date format - default: "M/d/yyyy"
timeFormatDomain time format - default: "h:mm:ss a"
timeZoneDomain time zone
parameters

An array containing all additional parameters

For parameters is defined the following structure:

NameDescription

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:

Code Block
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:

Code Block
javascript
javascript
{
  "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
    }
  ]
}


Sv translation
languageja

/api/domains/:id

IDで指定されたドメインに関する詳細をロードします。

Note

このリソースは、グローバル管理者とドメイン管理者がフルで利用できます。"非管理者ユーザーに表示"トグルがオンになっているドメインパラメーターは、非管理者ユーザーが読み取ることができます。

リソース情報

リソースURL

https://service.belladati.com/api/domains/:id

HTTPメソッド

GET

リクエストパラメーター

パラメーター

詳細

例

id

取得するドメインのID。IDは、/api/domainsへのレスポンスで見つけることができます。

123
showParametersFlagsBooleanパラメーター。 trueの場合、返されるJSONには、各パラメーターのnonAdminUserVisibleフラグが含まれます。 falseがデフォルトfalse

レスポンス構造

JSONレスポンスには、次の要素を持つ1つのJSONオブジェクトが含まれています:

名説明
idドメイン識別子
nameドメイン名
descriptionドメイン説明
activeドドメインがアクティブかどうかを示すBooleanフラグ
dateFormatドメインの日付形式 – デフォルト: "M/d/yyyy"
timeFormatドメインの時間形式 – デフォルト: "h:mm:ss a"
timeZoneドメインのタイムゾーン
parameters

すべての追加パラメーターを含む配列

パラメーターの場合、次の構造が定義されています:

名説明

parameter-name

パラメーター名

nonAdminUserVisible

管理者以外のユーザーがフラグを表示できるかどうかを示すBooleanフラグ。 showParametersFlags = trueのみの場合に返されます。

サンプルリクエスト/レスポンス

curl使用:

Code Block
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

JSON形式のレスポンス:

Code Block
javascript
javascript
{
  "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
    }
  ]
}