サンドボックスのリスト
IMS 組織（アクティブまたはその他）に属するすべてのサンドボックスをリストするには、/sandboxes エンドポイントに GET リクエストをおこないます。
API 形式
GET /sandboxes?{QUERY_PARAMS}
| パラメーター | 説明 |
|---|---|
{QUERY_PARAMS} |
結果をフィルターするオプションのクエリパラメーター。 詳しくは、 クエリパラメーターの節を参照してください 。 |
リクエスト
curl -X GET \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes?&limit=4&offset=1 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
成功応答は、組織に属するサンドボックスのリスト（name、title、state、type などの詳細を含むを返します。
{
"sandboxes": [
{
"name": "prod",
"title": "Production",
"state": "active",
"type": "production",
"region": "VA7",
"isDefault": true,
"eTag": 2,
"createdDate": "2019-09-04 04:57:24",
"lastModifiedDate": "2019-09-04 04:57:24",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
},
{
"name": "dev",
"title": "Development",
"state": "active",
"type": "development",
"region": "VA7",
"isDefault": false,
"eTag": 1,
"createdDate": "2019-09-03 22:27:48",
"lastModifiedDate": "2019-09-03 22:27:48",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
},
{
"name": "stage",
"title": "Staging",
"state": "active",
"type": "development",
"region": "VA7",
"isDefault": false,
"eTag": 1,
"createdDate": "2019-09-03 22:27:48",
"lastModifiedDate": "2019-09-03 22:27:48",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
},
{
"name": "dev-2",
"title": "Development 2",
"state": "creating",
"type": "development",
"region": "VA7",
"isDefault": false,
"eTag": 1,
"createdDate": "2019-09-07 10:16:02",
"lastModifiedDate": "2019-09-07 10:16:02",
"createdBy": "{USER_ID}",
"modifiedBy": "{USER_ID}"
}
],
"_page": {
"limit": 4,
"count": 4
},
"_links": {
"next": {
"href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes/?limit={limit}&offset={offset}",
"templated": true
},
"prev": {
"href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=0&limit=1",
"templated": null
},
"page": {
"href": "https://platform-int.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
"templated": null
}
}
}
| プロパティ | 説明 |
|---|---|
name |
サンドボックスの名前。API 呼び出しで参照目的に使用されます。 |
title |
サンドボックスの表示名。 |
state |
サンドボックスの現在の処理状態です。サンドボックスの状態は、次のいずれかになります。
|
type |
サンドボックスタイプ（「開発」または「実稼働」）。 |
isDefault |
このサンドボックスが組織のデフォルトのサンドボックスであるかどうかを示すブール型のプロパティです。通常、これは実稼働用サンドボックスです。 |
eTag |
サンドボックスの特定のバージョンの識別子。バージョン管理とキャッシュの効率化に使用され、この値はサンドボックスに変更が追加されるたびに更新されます。 |
クエリパラメーターの使用
この Sandbox APIは、サンドボックスのリスト表示時に、ページへのクエリパラメーターの使用と結果のフィルターをサポートしています。
メモ
と limit offset クエリのパラメーターは一緒に指定する必要があります。 1つのみ指定した場合、APIはエラーを返します。 noneを指定した場合、デフォルトの制限は50で、オフセットは0です。
| パラメーター | 説明 |
|---|---|
limit |
応答で返されるレコードの最大数です。 |
offset |
最初のレコードから応答リストの開始（オフセット）までのエンティティ数。 |