メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2023-06-23
シートの使用可否

シートの使用可否

URL エンドポイント

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
バージョン: v1
カテゴリ
メタデータの変更
説明
特定のシートおよび列の属性または特性値の使用可否設定を取得または更新します。
呼び出すために必要な権限
モデル管理アクセス
モデルに含まれるシート、科目、属性、数式
リクエストに必要なパラメータ
シート名、列名

サポートされている HTTP VERB

HTTP Verb
単一リソース
回収リソース
説明
GET
サポートされていません
サポート済
特定のシートと列のすべての値の使用可否を取得します。
POST
サポートされていません
サポート済
特定のシートと列の値の使用可否設定を更新します。
オプション
サポート済
サポート済
このコレクション リソースでサポートされている HTTP 動詞のリストを返します。

GET:

リクエスト:
/sheet/availability:
値の可用性のコレクションを取得します。
シート属性内のすべての値の使用可否設定を取得します。instanceCode、sheetName、columnName でフィルタできます。
リクエスト URI の例:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
リクエスト ヘッダーの例:
受諾言語: en
リクエスト本文の例
クエリー パラメータ
名前
説明
必須
sheetName
可用性の値を取得するシートの名前。
あり
columnName
使用可能日の値を取得するシート列の名前。キューブ シートでのみ必須です。
値の使用可否設定を変更できる列のみがサポートされています。
キューブ シートの科目と組織の列の場合、列の名前は Accept-Language ヘッダーに設定されたロケールを考慮します。
あり
columnCode
使用可能日の値を取得するシート列のコード。モデル シートでのみ必須です。
値の使用可否設定を変更できる列のみがサポートされています。
あり
columnType
指定された columnName または columnCode の列のタイプ。
入力可能な値: 科目、組織、属性、特性
あり
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
limit
単一の回答に含まれるオブジェクトの最大数
なし
offset
回答コレクション内の最初のオブジェクトの 0 から始まるインデックス。デフォルトは 0 です。
limit パラメータで offset を使用して、回答一覧のページングを制御します。
なし
回答例
200
正常に完了しました。
回答例
 
{
    "data": [
        {
            "code": "Corporate Plan",
            "name": "Corporate Plan",
            "available": true
        },
        {
            "code": "Engineering",
            "name": "Engineering",
            "available": true
        },
        {
            "code": "Development",
            "name": "Development",
            "available": true
        },
        {
            "code": "Documentation",
            "name": "Documentation",
            "available": true
        },
        {
            "code": "QA",
            "name": "QA",
            "available": true
        },
        {
            "code": "2014-Development Organization",
            "name": "2014-Development Organization",
            "available": false
        },
        {
            "code": "Development-India",
            "name": "Development-India",
            "available": false
        },
        {
            "code": "QA-India",
            "name": "QA-India",
            "available": false
        },
        {
            "code": "G & A",
            "name": "G & A",
            "available": false
        },
        {
            "code": "Hosting",
            "name": "Hosting",
            "available": true
        },
        {
            "code": "Professional Services",
            "name": "Professional Services",
            "available": true
        },
        {
            "code": "Sales",
            "name": "Sales",
            "available": true
        },
        {
            "code": "Marketing",
            "name": "Marketing",
            "available": true
        },
        {
            "code": "US Sales",
            "name": "US Sales",
            "available": false
        },
        {
            "code": "Worldwide Sales",
            "name": "Worldwide Sales",
            "available": true
        },
        {
            "code": "Asia Sales",
            "name": "Asia Sales",
            "available": false
        },
        {
            "code": "Europe Sales",
            "name": "Europe Sales",
            "available": true
        },
        {
            "code": "Latin America Sales",
            "name": "Latin America Sales",
            "available": true
        }
    ],
    "total": 18
}

POST:

リクエスト:
/sheet/availability:
値のコレクションを更新します。
シート属性内のすべての値の使用可否設定を更新します。
リクエスト URI の例:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
リクエスト ヘッダーの例:
受諾言語: en
リクエスト本文:
エクスポートの "データ" プロパティと一致する、空き状況オブジェクトの JSON 配列。各 JSON オブジェクトの構造は次のとおりです。
名前
説明
必須
code
値のコード。値を一意に識別するために使用されます。
あり
名前
値の名前。
あり
accountGroup
値が科目グループであるかどうか。科目の場合は必須です。
なし
使用可能
値が使用可能かどうか。存在しない場合、変更は行われません。
なし
deleteIfDataIsPresent
データが存在する場合に削除するかどうか。キューブ シートでカスタム属性値を無効にする場合は必須です。
なし
actionIfDataIsPresent
データが存在している場合に実行するアクション。モデル シートでカスタム属性値を無効にする場合は必須です。
なし
リクエスト本文の例
リクエスト本文
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
クエリー パラメータ
名前
説明
必須
sheetName
可用性の値を取得するシートの名前。
あり
columnName
使用可能日の値を取得するシート列の名前。キューブ シートでのみ必須です。
値の使用可否設定を変更できる列のみがサポートされています。
キューブ シートの科目と組織の列の場合、列の名前は Accept-Language ヘッダーに設定されたロケールを考慮します。
あり
columnCode
使用可否設定を取得するシート列のコードモデル シートでのみ必須です。
値の使用可否設定を変更できる列のみがサポートされています。
あり
columnType
指定された columnName または columnCode の列のタイプ。
入力可能な値: 科目、組織、属性、特性
あり
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
回答例:
204
成功した応答は空白で、ステータス コードは 204 です。