機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

ルールの取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}

リクエスト

パス・パラメータ

• RuleId(required): integer(int64)
  ルールの一意の識別子。 この値は作成アクション中に生成されます。
• RuleId2(required): integer(int64)
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: 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のデフォルト・バージョンを選択します。

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  ルール階層を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  階層が作成された日付。
• Description: string
  タイトル: Description

  最大長: 1000

  ルールの説明。
• EnabledFlag: boolean
  タイトル: Enabled

  最大長: 1

  デフォルト値: true

  ルールが有効かどうかを示します。
• EndDate: 文字列(日付)
  タイトル: End Date

  ルールが非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。
• LastUpdateDate: string (date-time)
  読取り専用: true

  階層が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  階層を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  階層を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

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

  最大長: 160

  ルールの名前。
• NumberOfWinners: 整数(int32)
  タイトル: Number of Winners

  デフォルト値: 1

  一致基準およびランクに基づいて獲得できるルールの数。 この値は、クレジット割当および関係者割当ルール・タイプに適用されます。
• OrganizationId: integer (int64)
  タイトル: Business Unit

  ビジネス・ユニットの一意の識別子。
• ParentRuleId: integer (int64)
  タイトル: Parent

  親ルールの一意の識別子。 この値は、親ルールのルール識別子にデフォルト設定されます。
• ParentRuleName: string
  タイトル: Name

  読取り専用: true

  最大長: 160

  親ルールの名前。
• ParentRuleNumber: string
  タイトル: Rule Number

  読取り専用: true

  最大長: 30

  親ルールの一意の識別子。
• Rank: integer (int64)
  タイトル: Rank

  ルールのプリファレンス。 この値は、割当中に他の優勢ルール間の関係を破る場合に便利です。 ランク番号が最も小さいルールは、同じ階層レベルの他のウィナー・ルールよりも優先されます。 この値は、分類、クレジットおよび関係者割当ルール・タイプに適用されます。
• RuleId: integer (int64)
  読取り専用: true

  ルールの一意の識別子。 この値は作成アクション中に生成されます。
• RuleNumber: string
  タイトル: Rule Number

  最大長: 30

  ルールの一意の識別子。 この値は、作成処理中にシステム生成またはユーザー指定にできます。
• RuleTypeId: integer (int64)
  タイトル: Rule Type

  ルール・タイプの一意の識別子。
• StartDate: 文字列(日付)
  タイトル: Start Date

  ルールがアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "NumberOfWinners":{
            "title":"Number of Winners",
            "type":"integer",
            "description":"The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rule hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleTypeId":{
            "title":"Rule Type",
            "type":"integer",
            "description":"The unique identifier of the rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ParentRuleName":{
            "title":"Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the parent rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of a rule. This values is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ParentRuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the parent rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the rule. This value can be system-generated or user-provided during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the hierarchy 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 hierarchy.",
            "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."
        }
    }
}

リンク

BusinessUnitLovViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

ビジネス・ユニット値リスト・リソースは、定義済ビジネス・ユニットのリストを表示するために使用されます。

EnabledFlagLovViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

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

ParentRuleViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

ルール階層リソースは、直接クレジット処理、分類、ロールアップ・クレジット処理、チーム・クレジット処理、参加者ロール割当およびアナリスト承認に使用されます。 ルール階層は、子ルールが親ルールの基準を継承する階層形式で編成されたルールのセットです。 ルール階層は、クレジット処理、分類、積上などのルール・タイプごとに作成および管理されます。

RuleTypeLovViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV

パラメータ:

• ファインダ: BuIdFinder

ルール・タイプ値リスト・リソースは、ルール・タイプのリストを表示するために使用されます。 分類、クレジット処理、その他の使用など、ルールの特定の使用を示します。

「トップに戻る」