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

機械翻訳について

サブスクリプション・メトリックの取得

get

/crmRestApi/resources/11.13.18.05/subscriptionMetrics/{subscriptionMetricsUniqID}

リクエスト

パス・パラメータ

subscriptionMetricsUniqID(required): string

これは、サブスクリプション・メトリック・リソースのコンポジット・キーを構成し、サブスクリプション・メトリックのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、サブスクリプション・メトリックの特定のインスタンスに移動してハッシュ・キーを取得するために、サブスクリプション・メトリック・コレクション・リソースを問い合せる必要があります。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
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
links: string

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

例:
self,canonical
onlyData: boolean

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

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : subscriptionMetrics-item-response

タイプ: object

ソースを表示

ClosedAmount: number

読取り専用: true

特定の期間のクローズ済サブスクリプションのために失権した金額。
CreatedBy: string

読取り専用: true

最大長: 64

サブスクリプション基準レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

サブスクリプション・メトリック・レコードが作成された日付。
CreditedAmount: number

読取り専用: true

特定の期間のアクティブなサブスクリプションの合計クレジット金額。
DiscountAmount: number

タイトル: Discount

読取り専用: true

特定の期間にオファーされた割引の合計金額。
EstimatedTax: number

タイトル: Estimated Tax

読取り専用: true

特定の期間のアクティブなサブスクリプションの合計見積税額です。
InvoicedAmount: number

読取り専用: true

特定の期間のアクティブなサブスクリプションの合計請求済金額。
LastUpdateDate: string (date-time)

読取り専用: true

サブスクリプション・メトリック・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

サブスクリプション・メトリック・レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

サブスクリプション・メトリック・レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: MRR

読取り専用: true

特定の期間の有効なサブスクリプションに対する月次経常売上の合計。
MrrAmendContractions: number

タイトル: Contraction MRR

読取り専用: true

指定期間の修正による差引月次経常収益合計。
MrrAmendExpansions: number

タイトル: Expansion MRR

読取り専用: true

指定期間の修正による純月次経常収益合計。
MrrChurnRenewLapses: number

タイトル: Lapsed Renewal MRR

読取り専用: true

特定の期間の更新なしで失効したサブスクリプションの正味月次経常収益合計。
MrrClosedSubscriptions: number

タイトル: Termination MRR

読取り専用: true

特定の期間の退職による差引月次経常収益合計。
MrrDueRenewal: number

タイトル: MRR Due for Renewal

読取り専用: true

特定の期間における更改の正味月次経常収益合計。
MrrNewSubscriptions: number

タイトル: New MRR

読取り専用: true

特定の期間に開始された新規サブスクリプションの純月次経常収益合計。これらのサブスクリプションは、修正、更改および再開の結果ではありません。
MrrRenewActive: number

タイトル: Activated Renewal MRR

読取り専用: true

特定の期間に正常に更改された正味月次経常収益の合計。
MrrRenewChurn: number

タイトル: Churned Renewal MRR

読取り専用: true

特定の期間に更改されたが取り消されたサブスクリプションの正味月次経常収益合計。
NumberClosedSubscriptions: number

タイトル: Number of Terminated Subscriptions

読取り専用: true

特定の期間に終了したサブスクリプションの合計数。
NumberNewSubscriptions: number

タイトル: Number of New Subscriptions

読取り専用: true

特定の期間に開始された新規サブスクリプションの合計数。これらのサブスクリプションは、修正、更改および再開の結果ではありません。
NumberRenewedSubscriptions: number

タイトル: Number of Renewed Subscriptions

読取り専用: true

特定の期間に更改されたサブスクリプションの合計数。
NumberSubscriptions: number

タイトル: Number of Subscriptions

読取り専用: true

特定の期間のアクティブなサブスクリプションの合計数。
PartyName: string

タイトル: Party Name

読取り専用: true

最大長: 360

サブスクリプション・メトリックが検索されるパーティの名前。
PartyNumber: string

タイトル: Party Number

読取り専用: true

最大長: 30

サブスクリプション・メトリックが検索されるパーティの番号。
PeriodCode: 整数(int32)

読取り専用: true

サブスクリプション・メトリックが検索されるサブスクリプション・メトリックのスナップショット期間のコード。
PeriodEndDate: 文字列(日付)

タイトル: Period End Date

読取り専用: true

サブスクリプション・メトリックのスナップショット期間の終了日。
PeriodMonth: number

タイトル: Period Month

読取り専用: true

サブスクリプション・メトリックのスナップショット期間の月。有効な値は整数1 ~ 12です。
PeriodName: string

タイトル: Period Name

読取り専用: true

最大長: 256

サブスクリプション・メトリック・スナップショット期間の名前。
PeriodQuarter: number

タイトル: Period Quarter

読取り専用: true

サブスクリプション・メトリック・スナップショット期間の四半期。
PeriodStartDate: 文字列(日付)

タイトル: Period Start Date

読取り専用: true

サブスクリプション・メトリックのスナップショット期間の開始日。
PeriodType: string

読取り専用: true

最大長: 4

一部期間計算に使用されるデフォルト期間タイプ。
PeriodYear: number

タイトル: Period Year

読取り専用: true

サブスクリプション・メトリックのスナップショット期間の年。有効な値は2019、2020などです。
PrimaryPartyId: integer (int64)

読取り専用: true

サブスクリプション・メトリックが検索されるプライマリ・パーティの識別子。
ProductNetPrice: number

タイトル: Net Price

読取り専用: true

指定した期間のアクティブなサブスクリプションの合計契約値。
ProductTotal: number

タイトル: Product Total

読取り専用: true

特定の期間のアクティブなサブスクリプションの合計値。
SuppressedCreditAmount: number

タイトル: Suppressed Credit Amount

読取り専用: true

特定の期間に終了したサブスクリプションに使用されたクローズ・クレジット・メソッドに基づいて抑制された合計クレジット金額。
TotalQuantity: number

タイトル: Total Quantity

読取り専用: true

特定の期間のアクティブなサブスクリプションの数量の合計。

{
    "type":"object",
    "properties":{
        "MrrAmendExpansions":{
            "title":"Expansion MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue gained by amendments in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrDueRenewal":{
            "title":"MRR Due for Renewal",
            "type":"number",
            "description":"The total net monthly recurring revenue due for renewal in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "maxLength":4,
            "type":"string",
            "description":"The default period type used for the partial period calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The total monthly recurring revenue for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberClosedSubscriptions":{
            "title":"Number of Terminated Subscriptions",
            "type":"number",
            "description":"The total number of subscriptions terminated in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription metric record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodYear":{
            "title":"Period Year",
            "type":"number",
            "description":"The year of the subscription metric snapshot period. The valid values are 2019, 2020, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrChurnRenewLapses":{
            "title":"Lapsed Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of subscriptions that expired without any renewal in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party for which subscription metrics are sought.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPartyId":{
            "type":"integer",
            "description":"The identifier of the primary party for which subscription metrics are sought.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"Period End Date",
            "type":"string",
            "description":"The end date of the subscription metric snapshot period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTotal":{
            "title":"Product Total",
            "type":"number",
            "description":"The total value of active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberNewSubscriptions":{
            "title":"Number of New Subscriptions",
            "type":"number",
            "description":"The total number of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals and resumptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalQuantity":{
            "title":"Total Quantity",
            "type":"number",
            "description":"The sum of quantities of active subscriptions in a given period.",
            "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"
            }
        },
        "NumberRenewedSubscriptions":{
            "title":"Number of Renewed Subscriptions",
            "type":"number",
            "description":"The total number of subscriptions that were renewed in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrRenewActive":{
            "title":"Activated Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue that were successfully renewed in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCode":{
            "type":"integer",
            "description":"The code of the subscription metric snapshot period for which subscription metrics are sought.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "MrrClosedSubscriptions":{
            "title":"Termination MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue lost due to terminations in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription metric record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNetPrice":{
            "title":"Net Price",
            "type":"number",
            "description":"The total contract value of active subscriptions in the given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription metric record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberSubscriptions":{
            "title":"Number of Subscriptions",
            "type":"number",
            "description":"The total number of active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodQuarter":{
            "title":"Period Quarter",
            "type":"number",
            "description":"The quarter of the subscription metric snapshot period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrRenewChurn":{
            "title":"Churned Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of subscriptions which were renewed but got canceled in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The total credited amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrNewSubscriptions":{
            "title":"New MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals, and resumptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The total estimated tax amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"The start date of the subscription metric snapshot period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount",
            "type":"number",
            "description":"The total amount of discounts offered in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodMonth":{
            "title":"Period Month",
            "type":"number",
            "description":"The month of the subscription metric snapshot period. The valid values are integers one through 12.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount forfeited due to closed subscription in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the party for which subscription metrics are sought.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The total credit amount that's suppressed based on the close credit method used for subscriptions terminated in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrAmendContractions":{
            "title":"Contraction MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue lost by amendments in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription metric snapshot period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The total invoiced amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription metric record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription metric record.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行してサブスクリプション・メトリックを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionMetrics/100100350340130  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "PartyName": "A T & T SOLUTIONS INC",
    "PartyNumber": "1001",
    "PrimaryPartyId": 1001,
    "PeriodType": "MNTH",
    "PeriodMonth": 4,
    "PeriodQuarter": 2,
    "PeriodYear": 2020,
    "PeriodStartDate": "2020-04-01",
    "PeriodEndDate": "2020-04-30",
    "PeriodCode": 2020204,
    "PeriodName": "2020 / 04",
    "ClosedAmount": 0,
    "CreditedAmount": 0,
    "DiscountAmount": 22317,
    "EstimatedTax": 857432.22,
    "InvoicedAmount": 0,
    "MonthlyRecurringRevenue": 278738.94,
    "MrrAmendContractions": 0,
    "MrrAmendExpansions": 0,
    "MrrChurnRenewLapses": 0,
    "MrrClosedSubscriptions": 0,
    "MrrDueRenewal": 0,
    "MrrNewSubscriptions": 28094.54,
    "MrrRenewActive": 0,
    "MrrRenewChurn": 0,
    "NumberClosedSubscriptions": 0,
    "NumberNewSubscriptions": 3,
    "NumberRenewedSubscriptions": 0,
    "NumberSubscriptions": 32,
    "ProductNetPrice": 4287161.13,
    "ProductTotal": 5144593.35,
    "SuppressedCreditAmount": 0,
    "TotalQuantity": 94,
    "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
    "CreationDate": "2021-06-28T18:44:09.415+00:00",
    "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
    "LastUpdateDate": "2021-06-28T18:44:09.415+00:00",
    "LastUpdateLogin": "C5D694E7310A7A4AE0533DFDF40A90D5",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionMetrics/100100350340130",
            "name": "subscriptionMetrics",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionMetrics/100100350340130",
            "name": "subscriptionMetrics",
            "kind": "item"
        }
    ]
}

「トップに戻る」