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

修飾属性値の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}

リクエスト

パス・パラメータ

RuleAttributeId(required): integer(int64)

ルール属性の一意の識別子。この値は作成アクション中に生成されます。
RuleAttributeValueId(required): integer(int64)

ルール属性値の一意の識別子。
RuleId(required): integer(int64)

ルールの一意の識別子。この値は作成アクション中に生成されます。

問合せパラメータ

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

ルート・スキーマ : incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response

タイプ: object

ソースを表示

ComparisonOperator: string

タイトル: Operator

最大長: 30

デフォルト値: EQUAL_TO

次と等しい、類似、次の間にあるなどの比較演算子。受け入れられる値のリストは、参照タイプCN_RS_COMPARISON_OPERATORSで定義されます。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
CreatedBy: string

読取り専用: true

最大長: 64

適格属性値を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

適格属性値が作成された日付。
HighValueCharacter: string

タイトル: Character High Value

最大長: 360

文字属性の上限値。この値は、資格取得条件が自由形式テキストで、演算子が範囲内にある場合に適用されます。
HighValueNumber: integer

タイトル: High Value Number

数値属性の上限値。この値は、資格取得条件が数値で、演算子が次の間にあるの場合に適用できます。
LastUpdateDate: string (date-time)

読取り専用: true

適格属性値が最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

資格該当属性値を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

適格属性値を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Character Low Value

最大長: 360

文字属性の下限値。この値は、資格取得条件がテキスト(自由形式)の場合に適用されます。
LowValueCharacterCode: string

最大長: 360

資格取得基準値の参照コード。この値は、トランザクション・タイプなど、適格基準が参照値セットに基づいている場合に適用されます。
LowValueCharacterId: integer (int64)

属性値の一意の識別子。資格取得基準が、クレジット・カテゴリなどのユーザー定義オブジェクト値セットに基づいている場合に適用されます。
LowValueNumber: integer

タイトル: Low Value Number

数値属性の下限値。この値は、資格取得条件が数値で、演算子が次の間にあるの場合に適用できます。
OrganizationId: integer (int64)

ビジネス・ユニットの一意の識別子。
RuleAttributeId: integer (int64)

ルール属性の一意の識別子。
RuleAttributeValueId: integer (int64)

読取り専用: true

ルール属性値の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeValueId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ComparisonOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"EQUAL_TO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HighValueNumber":{
            "title":"High Value Number",
            "type":"integer",
            "description":"The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HighValueCharacter":{
            "title":"Character High Value",
            "maxLength":360,
            "type":"string",
            "description":"The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueNumber":{
            "title":"Low Value Number",
            "type":"integer",
            "description":"The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueCharacterCode":{
            "maxLength":360,
            "type":"string",
            "description":"The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.",
            "nullable":true,
            "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"
            }
        },
        "LowValueCharacterId":{
            "type":"integer",
            "description":"The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LowValueCharacter":{
            "title":"Character Low Value",
            "maxLength":360,
            "type":"string",
            "description":"The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the qualifying attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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."
        }
    }
}

リンク

AttributeValuesLookupViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV

パラメータ:

ファインダ: ByRuleAttributeWithLookupIdRowFinder

ルール属性値値リスト・リソースは、ルール属性またはクオリファイアに関連付けられた値のリストを表示するために使用されます。

ComparisonOperatorsLovViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

「トップに戻る」