Versions Compared

Old Version 8

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

Lists all domains.

Note

This resource is available only for Global admin and only in multi-domain configurations.

Resource Information

Resource URL

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

HTTP Method

GET

Request Parameters

Parameters

Detail

Example
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 array "domains" that contains multiple domain objects with following definition:

NameDescription
idDomain identifier
nameDomain name
descriptionDomain description
activeBoolean flag indicating if the 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

The JSON format response:

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


Sv translation
languageja

/api/domains

全てのドメインを列記します

Note

このリソースは、グローバル管理者およびマルチドメイン構成で利用可能です。

リソース情報

リソースURL

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

HTTPメソッド

GET

リクエストパラメーター

パラメーター

詳細l

例
showParametersFlags

Booleanパラメーター。trueの場合、返されるJSONには、各パラメーターのnonAdminUserVisibleフラグが含まれます。

false

レスポンスの構造

SONレスポンスには、複数のドメインオブジェクトが定義された「ドメイン」配列が含まれています:

名説明
idドメイン識別子
nameドメイン名
descriptionドメイン説明
activeドメインがアクティブである場合に示すBooleanフラグ
dateFormatドメインの日付フォーマット - デフォルト: "M/d/yyyy"
timeFormatドメインの時間フォーマット - デフォルト: "h:mm:ss a"
timeZoneドメインのタイムゾーン
parameters

配列がすべての追加パラメーターを含みます

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

JSONフォーマットのレスポンス:

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