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

残高基準の取得

get

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}

リクエスト

パス・パラメータ

BalanceCriteriaNumber(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
EntitlementAssignmentNumber(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

問合せパラメータ

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

ルート・スキーマ : subscriptionEntitlementAssignments-assignmentCriteria-item-response

タイプ: object

ソースを表示

BalanceCriteriaDescription: string

タイトル: Description

最大長: 300

サブスクリプション残高基準の摘要。
BalanceCriteriaId: integer (int64)

サブスクリプション残高基準の一意の識別子。
BalanceCriteriaNumber: string

タイトル: Criteria

最大長: 120

サブスクリプション残高基準の一意の番号。
BalanceCriteriaStatus: string

タイトル: Status

最大長: 30

デフォルト値: ORA_OSS_DRAFT

サブスクリプション残高基準のステータス。
BalanceCriteriaUsage: string

タイトル: Usage

最大長: 30

サブスクリプション残高基準の使用条件。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

サブスクリプション残高基準が作成された日付。
LastUpdateDate: string (date-time)

読取り専用: true

サブスクリプション残高基準が最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

サブスクリプション残高基準を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

サブスクリプション残高基準を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

サブスクリプション残高基準の更新のたびに更新されるオブジェクト・バージョン番号。
subscriptionBalancePredicates: array Subscription Balance Predicates

タイトル: Subscription Balance Predicates

サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The usage condition of subscription balance criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion 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 balance criterion.",
            "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"
    }
}

ネストされたスキーマ : サブスクリプション残高述語

タイプ: array

タイトル: Subscription Balance Predicates

サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

ソースを表示

Array of: object subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response"
    }
}

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

タイプ: 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."
        }
    }
}

ネストされたスキーマ : subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response

タイプ: object

ソースを表示

BalanceAttributeId: integer (int64)

サブスクリプション残高属性の一意の識別子。
BalanceAttributeName: string

タイトル: Attribute Name

最大長: 240

サブスクリプション残高属性の名前。
BalanceCriteriaId: integer (int64)

サブスクリプション残高述語の残高基準ID。
BalanceObjectId: integer (int64)

サブスクリプション残高述語のバランス・オブジェクト識別子。
BalanceObjectName: string

タイトル: Object Name

最大長: 120

サブスクリプション残高述語のバランス・オブジェクト名。
BalancePredicateCharacterValue: string

タイトル: Value

最大長: 600

サブスクリプション残高述語の残高述語文字値。
BalancePredicateDateValue: 文字列(日付)

タイトル: Value

サブスクリプション残高述語の残高述語日付値です。
BalancePredicateDecimalValue: number

タイトル: Value

サブスクリプション残高述語の残高述語10進数値。
BalancePredicateId: integer (int64)

サブスクリプション残高述語の一意の識別子。
BalancePredicateNumber: string

タイトル: Number

最大長: 120

サブスクリプション残高述語の一意の番号。
BalancePredicateNumberValue: integer

タイトル: Value

サブスクリプション残高述語の数値。
BalancePredicateOperator: string

タイトル: Operator

最大長: 30

サブスクリプション残高述語の演算子値。
BalancePredicateSequence: integer

タイトル: Sequence

サブスクリプション残高述語の残高述語シーケンス。
BalancePredicateSortBy: string

タイトル: Sort Order

最大長: 30

サブスクリプション残高述語の基準でソートします。
BalancePredicateTimeValue: string (date-time)

タイトル: Value

サブスクリプション残高述語の時間値。
CreatedBy: string

読取り専用: true

最大長: 64

サブスクリプション残高述語を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

サブスクリプション残高述語が作成された日付。
LastUpdateDate: string (date-time)

読取り専用: true

サブスクリプション残高述語が最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

サブスクリプション残高述語を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

サブスクリプション残高述語を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

読取り専用: true

サブスクリプション残高述語のオブジェクト・バージョン番号。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance predicate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance predicate.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate 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 balance predicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "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"
    }
}

リンク

BalanceCriteriaStatusVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: BalanceCriteriaStatus;ターゲット属性: LookupCode
表示属性: 意味

BalanceCriteriaUsageVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALNCE_CRITERIA_USAGE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: BalanceCriteriaUsage;ターゲット属性: LookupCode
表示属性: 意味

アクティブ化

操作: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/action/activate

パラメータ:

BalanceCriteriaNumber: $request.path.BalanceCriteriaNumber
EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

このメソッドは、残高条件をアクティブにするために使用されます。

deActivate

操作: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/action/deActivate

パラメータ:

BalanceCriteriaNumber: $request.path.BalanceCriteriaNumber
EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

このメソッドは、残高基準の非アクティブ化に使用されます。

subscriptionBalancePredicates

操作: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates

パラメータ:

BalanceCriteriaNumber: $request.path.BalanceCriteriaNumber
EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

サブスクリプション残高述語リソースは、残高述語の表示に使用されます。

「トップに戻る」