Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての販売予測メトリックの取得

get

/crmRestApi/resources/11.13.18.05/salesForecastMetrics

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します
- PrimaryKey主キー別に売上予測メトリックを検索します。
  ファインダ変数
  - MetricCode; string; 予測メトリックの検索に使用されるメトリックの名前。
  - MetricDimFiveKey; integer; 予測メトリックの検索に使用される5番目のディメンションの一意キー。
  - MetricDimFourKey; integer; 予測メトリックの検索に使用される4番目のディメンションの一意キー。
  - MetricDimOneKey; integer; 予測メトリックの検索に使用される最初のディメンションの一意キー。
  - MetricDimThreeKey; integer; 予測メトリックの検索に使用される3番目のディメンションの一意キー。
  - MetricDimTwoKey; integer; 予測メトリックの検索に使用される2番目のディメンションの一意キー。
  - MetricLevel; string; 予測メトリックの検索に使用されるメトリックのレベル。
  - PeriodId; integer; 売上予測メトリックの検索に使用されるメトリック期間の一意の識別子。
  - SnapshotId; integer; 売上予測メトリックの検索に使用されるスナップショットの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- DimFiveRootFlag; boolean。5番目のディメンション・キーが階層のルートであるかどうかを示します。
- DimFourRootFlag; boolean; 4番目のディメンション・キーが階層のルートであるかどうかを示します。
- DimOneRootFlag; boolean。最初のディメンション・キーが階層のルートであるかどうかを示します。
- DimThreeRootFlag; boolean。3番目のディメンション・キーが階層のルートであるかどうかを示します。
- DimTwoRootFlag; boolean。2番目のディメンション・キーが階層のルートであるかどうかを示します。
- MetricCode; string; 売上予測メトリックの名前。
- MetricDimFiveKey; integer; 5番目のメトリック・ディメンションの一意のキー。
- MetricDimFourKey; integer; 4番目のメトリック・ディメンションの一意のキー。
- MetricDimOneKey; integer; 最初のメトリック・ディメンションの一意のキー。
- MetricDimThreeKey; integer; 3番目のメトリック・ディメンションの一意のキー。
- MetricDimTwoKey; integer; 2番目のメトリック・ディメンションの一意キー。
- MetricLevel; string; メトリックがすべての部下のロールアップ値であるか、直接所有されているすべてのレコードの合計であるか、または両方のメトリックの合計であるかを示します。
- PeriodName; string; 予測メトリック期間の名前。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : salesForecastMetrics

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesForecastMetrics-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object salesForecastMetrics-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesForecastMetrics-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : salesForecastMetrics-item-response

タイプ: object

ソースを表示

DimFiveRootFlag: boolean

読取り専用: true

最大長: 1

5番目のディメンション・キーが階層のルートであるかどうかを示します。
DimFourRootFlag: boolean

読取り専用: true

最大長: 1

4番目のディメンション・キーが階層のルートであるかどうかを示します。
DimOneRootFlag: boolean

読取り専用: true

最大長: 1

最初のディメンション・キーが階層のルートであるかどうかを示します。
DimThreeRootFlag: boolean

読取り専用: true

最大長: 1

3番目のディメンション・キーが階層のルートであるかどうかを示します。
DimTwoRootFlag: boolean

読取り専用: true

最大長: 1

2番目のディメンション・キーが階層のルートであるかどうかを示します。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MetricCode: string

読取り専用: true

最大長: 40

販売予測メトリックの名前。
MetricDimFiveCode: string

読取り専用: true

メトリック・ロールアップの5番目の登録済ディメンションのディメンション・コード。
MetricDimFiveKey: integer

読取り専用: true

5番目のメトリック・ディメンションの一意キー。
MetricDimFourCode: string

読取り専用: true

メトリック・ロールアップの4番目の登録済ディメンションのディメンション・コード。
MetricDimFourKey: integer

読取り専用: true

4番目のメトリック・ディメンションの一意キー。
MetricDimOneCode: string

読取り専用: true

メトリック・ロールアップの最初の登録済ディメンションのディメンション・コード
MetricDimOneKey: integer

読取り専用: true

最初のメトリック・ディメンションの一意キー。
MetricDimThreeCode: string

読取り専用: true

メトリック・ロールアップの3番目の登録済ディメンションのディメンション・コード
MetricDimThreeKey: integer

読取り専用: true

3番目のメトリック・ディメンションの一意キー。
MetricDimTwoCode: string

読取り専用: true

メトリック・ロールアップの2番目の登録済ディメンションのディメンション・コード
MetricDimTwoKey: integer

読取り専用: true

2番目のメトリック・ディメンションの一意キー。
MetricLevel: string

読取り専用: true

最大長: 30

メトリックがすべての部下のロールアップ値であるか、直接所有されているすべてのレコードの合計であるか、または両方のメトリックの合計であるかを示します。
MetricValue: number

読取り専用: true

販売予測メトリックの金額または金額。
PeriodId: integer

読取り専用: true

予測メトリック期間の一意の識別子。
PeriodName: string

最大長: 255

予測メトリック期間の名前。
SnapshotId: integer

読取り専用: true

予測メトリック・スナップショットの一意の識別子。

{
    "type":"object",
    "properties":{
        "MetricDimOneCode":{
            "type":"string",
            "description":"The dimension code of the first registered dimension for metrics rollups",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MetricDimThreeKey":{
            "type":"integer",
            "description":"The unique key of the third metric dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimTwoCode":{
            "type":"string",
            "description":"The dimension code of the second registered dimension for metrics rollups",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DimOneRootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the first dimension key is the root of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimThreeCode":{
            "type":"string",
            "description":"The dimension code of the third registered dimension for metrics rollups",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MetricDimFiveCode":{
            "type":"string",
            "description":"The dimension code of the fifth registered dimension for metrics rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodId":{
            "type":"integer",
            "description":"The unique identifier of the forecast metric period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MetricDimFiveKey":{
            "type":"integer",
            "description":"The unique key of the fifth metric dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimThreeRootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the third dimension key is the root of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimFourRootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the forth dimension key is the root of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimFiveRootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the fifth dimension key is the root of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimFourKey":{
            "type":"integer",
            "description":"The unique key of the fourth metric dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SnapshotId":{
            "type":"integer",
            "description":"The unique identifier of the forecast metric snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MetricDimFourCode":{
            "type":"string",
            "description":"The dimension code of the fourth registered dimension for metrics rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MetricValue":{
            "type":"number",
            "description":"The amount or value of the sales forecast metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DimTwoRootFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the second dimension key is the root of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricCode":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the sales forecast metric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricDimOneKey":{
            "type":"integer",
            "description":"The unique key of the first metric dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the forecast metric period.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the metric is a rolled up value of all subordinates, is a total of all records directly owned, or is a sum of the both these metrics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimTwoKey":{
            "type":"integer",
            "description":"The unique key of the second metric dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」