資格/権利割当の更新
patch
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}
リクエスト
パス・パラメータ
- EntitlementAssignmentNumber(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
assignmentCriteria: array Subscription Balance Criteria
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。 -
AssignmentPrecedence: integer
タイトル:
Precedence
サブスクリプション資格/権利割当の割当の優先度。 -
AssignmentStatus: string
タイトル:
Status
最大長:30
デフォルト値:ORA_OSS_DRAFT
サブスクリプション資格/権利割当の割当のステータス。 -
EndDateActive: 文字列(日付)
タイトル:
End Date
サブスクリプション資格/権利割当で割当がアクティブになる終了日。 -
EntitlementPlanId: integer (int64)
サブスクリプション資格/権利割当の一意の資格/権利プラン識別子。
-
EntitlementPlanName: string
タイトル:
Entitlement Plan Name
最大長:120
サブスクリプション資格/権利割当の資格/権利プラン名。 -
EntitlementPlanNumber: string
タイトル:
Entitlement Plan Number
最大長:120
サブスクリプション資格/権利割当の資格/権利プラン番号。 -
InventoryItemId: integer (int64)
サブスクリプション資格/権利割当のインベントリ・アイテム識別子。
-
InventoryItemName: string
タイトル:
Product Name
最大長:300
サブスクリプション資格/権利割当のインベントリ・アイテム名。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション資格/権利割当のバージョン番号。
-
OrganizationCode: string
タイトル:
Organization
最大長:18
サブスクリプション資格/権利割当の組織コード。 -
OrganizationId: integer (int64)
サブスクリプション資格/権利割当の組織識別子。
-
StartDateActive: 文字列(日付)
タイトル:
Start Date
サブスクリプション資格/権利割当で割当がアクティブな開始日。
ネストされたスキーマ : サブスクリプション残高基準
タイプ:
array
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
BalanceCriteriaDescription: string
タイトル:
Description
最大長:300
サブスクリプション残高基準の摘要。 -
BalanceCriteriaNumber: string
タイトル:
Criteria
最大長:120
サブスクリプション残高基準の一意の番号。 -
BalanceCriteriaStatus: string
タイトル:
Status
最大長:30
デフォルト値:ORA_OSS_DRAFT
サブスクリプション残高基準のステータス。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション残高基準の更新のたびに更新されるオブジェクト・バージョン番号。
-
subscriptionBalancePredicates: array Subscription Balance Predicates
タイトル:
Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ネストされたスキーマ : サブスクリプション残高述語
タイプ:
array
タイトル:
Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
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進数値。 -
BalancePredicateNumberValue: integer
タイトル:
Value
サブスクリプション残高述語の数値。 -
BalancePredicateOperator: string
タイトル:
Operator
最大長:30
サブスクリプション残高述語の演算子値。 -
BalancePredicateSequence: integer
タイトル:
Sequence
サブスクリプション残高述語の残高述語シーケンス。 -
BalancePredicateSortBy: string
タイトル:
Sort Order
最大長:30
サブスクリプション残高述語の基準でソートします。 -
BalancePredicateTimeValue: string (date-time)
タイトル:
Value
サブスクリプション残高述語の時間値。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionEntitlementAssignments-item-response
タイプ:
ソースを表示
object
-
assignmentCriteria: array Subscription Balance Criteria
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。 -
AssignmentPrecedence: integer
タイトル:
Precedence
サブスクリプション資格/権利割当の割当の優先度。 -
AssignmentStatus: string
タイトル:
Status
最大長:30
デフォルト値:ORA_OSS_DRAFT
サブスクリプション資格/権利割当の割当のステータス。 -
CreatedBy: string
読取り専用:
true
最大長:64
サブスクリプション資格割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サブスクリプション資格割当が作成された日付。 -
EndDateActive: 文字列(日付)
タイトル:
End Date
サブスクリプション資格/権利割当で割当がアクティブになる終了日。 -
EntitlementAssignmentId: integer (int64)
サブスクリプション資格割当の一意の識別子。
-
EntitlementAssignmentNumber: string
タイトル:
Number
最大長:120
サブスクリプション資格/権利割当の数。 -
EntitlementPlanId: integer (int64)
サブスクリプション資格/権利割当の一意の資格/権利プラン識別子。
-
EntitlementPlanName: string
タイトル:
Entitlement Plan Name
最大長:120
サブスクリプション資格/権利割当の資格/権利プラン名。 -
EntitlementPlanNumber: string
タイトル:
Entitlement Plan Number
最大長:120
サブスクリプション資格/権利割当の資格/権利プラン番号。 -
InventoryItemId: integer (int64)
サブスクリプション資格/権利割当のインベントリ・アイテム識別子。
-
InventoryItemName: string
タイトル:
Product Name
最大長:300
サブスクリプション資格/権利割当のインベントリ・アイテム名。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サブスクリプション資格割当が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
サブスクリプション資格割当を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
サブスクリプション資格割当を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
サブスクリプション資格/権利割当のバージョン番号。
-
OrganizationCode: string
タイトル:
Organization
最大長:18
サブスクリプション資格/権利割当の組織コード。 -
OrganizationId: integer (int64)
サブスクリプション資格/権利割当の組織識別子。
-
StartDateActive: 文字列(日付)
タイトル:
Start Date
サブスクリプション資格/権利割当で割当がアクティブな開始日。
ネストされたスキーマ : サブスクリプション残高基準
タイプ:
array
タイトル:
Subscription Balance Criteria
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。
ソースを表示
ネストされたスキーマ : 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
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ネストされたスキーマ : サブスクリプション残高述語
タイプ:
array
タイトル:
Subscription Balance Predicates
サブスクリプション残高述語リソースは、残高述語の表示に使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : 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
サブスクリプション残高述語のオブジェクト・バージョン番号。
リンク
- アクティブ化
-
パラメータ:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
このメソッドは、休暇付与割当のアクティブ化に使用されます。 - EntitlementAssignmentNumber:
- assignmentCriteria
-
パラメータ:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
サブスクリプション残高基準リソースは、残高基準を表示するために使用されます。 - EntitlementAssignmentNumber:
- deActivate
-
パラメータ:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
このメソッドは、休暇付与割当の非アクティブ化に使用されます。 - EntitlementAssignmentNumber:
例:
次の例は、RESTリソースでPATCHリクエストを発行して、サブスクリプション資格割当てを更新する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionEntitlementAssignments/CDRM_7004 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{ "AssignmentPrecedence": 1021 }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "EntitlementAssignmentId": 300100570207771, "EntitlementAssignmentNumber": "CDRM_7004", "OrganizationCode": "V1", "OrganizationId": 204, "InventoryItemName": "QP_Item3", "InventoryItemId": 300100012368232, "EntitlementPlanNumber": "CDRM_1", "EntitlementPlanId": 300100570153904, "EntitlementPlanName": "Platinum Plan", "AssignmentPrecedence": 1021, "StartDateActive": "2023-03-01", "EndDateActive": null, "AssignmentStatus": "ORA_OSS_DRAFT", "ObjectVersionNumber": 2, "CreatedBy": "CONMGR", "CreationDate": "2023-03-01T15:05:58+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2023-03-01T15:15:05+00:00", "LastUpdateLogin": "F5D244E63FDB3FFBE053B4A7456445B7", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004", "name": "subscriptionEntitlementAssignments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004", "name": "subscriptionEntitlementAssignments", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria", "name": "assignmentCriteria", "kind": "collection" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/activate", "name": "activate", "kind": "other" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/deActivate", "name": "deActivate", "kind": "other" } ] }