/ /

/ /

すべての組織を取得

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /orgs

Request Parameters

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前	タイプ	説明	default
`pageNum`	integer	ページ番号（1 から始まる）。	`1`
`itemsPerPage`	integer	1 ページあたりに返す項目の数は最大 500 です。	`100`
`pretty`	ブール値	応答を pretty-print形式で表示します。	`false`
`envelope`	ブール値	応答をエンベロープでラップするかどうかを指定します。	`false`
`name`	string	指定された組織名に基づいて結果をフィルタリングします。指定された`name`と完全に一致する組織を、大文字と小文字を区別せずに検索します。たとえば、 `org1`の`name`クエリパラメータを指定すると、Cloud Manager は`org1`と`Org1`という名前の組織を返しますが、 `org123`という名前の組織は返しません。	なし

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、result オブジェクトの配列、link オブジェクトの配列、および取得されたresult オブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。URL間の関係は、Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つの組織です。

名前	タイプ	説明
id	string	組織の一意の識別子です。
isDeleted	ブール値	組織が削除されたかどうかを示すフラグ。
name	string	組織名。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/"

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "links" : [{
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs",
    "rel" : "self"
  }],
  "results" : [
    {
      "id" : "{ORG-ID1}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Internal Application Support"
    },
    {
      "id" : "{ORG-ID2}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Customer Application Support"
    },
    {
      "id" : "{ORG-ID3}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Research and Development"
    }
  ],
  "totalCount" : 3
}

戻る

組織

1 つの取得

すべての組織を取得

Resource

Request Parameters

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

応答ドキュメント

results embeddedDocument

リクエストの例

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ

`results` embeddedDocument