機械翻訳について

ジャンプ先

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

プラン・コンポーネント属性の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}

リクエスト

パス・パラメータ

• expressionDetailPlanComponentAttributesUniqID(required): string
  これは、式詳細プラン・コンポーネント属性リソースに対してコンポジット・キー(PlanComponentId、OrgIdおよびAttributeConfigId)を構成する属性のハッシュ・キーで、式詳細プラン・コンポーネント属性のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、式詳細プラン・コンポーネント属性の特定のインスタンスに移動するために、主キー値に対するフィルタを使用して式詳細プラン・コンポーネント属性コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: expressionDetailPlanComponentAttributes?q=PlanComponentId=<value1>;OrgId=<value2>;AttributeConfigId=<value3>
• expressionDetailPlanComponentsUniqID(required): string
  これは、式詳細プラン・コンポーネント・リソースに対してコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、式詳細プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、式詳細プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用して式詳細プラン・コンポーネント・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: expressionDetailPlanComponents?q=PlanComponentId=<value1>;OrgId=<value2>
• incentiveCompensationExpressionDetailItemsLOVUniqID(required): string
  これは、式詳細アイテム・リソースのコンポジット・キー(OrgIdおよびExpressionDetailType)を構成する属性のハッシュ・キーで、式詳細アイテムのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、式詳細アイテムの特定のインスタンスに移動するために、主キー値に対するフィルタを使用して式詳細アイテム・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: incentiveCompensationExpressionDetailItemsLOV?q=OrgId=<value1>;ExpressionDetailType=<value2>

問合せパラメータ

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

本文( )

ルート・スキーマ : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-item-response

タイプ: object

ソースを表示

• AttributeConfigId: number
  読取り専用: true

  プラン・コンポーネントの属性の一意の識別子。
• expressionDetailPlanComponentsMeasures: array Expression Detail Plan Component Measures
  タイトル: Expression Detail Plan Component Measures

  プラン・コンポーネント・メジャー値リスト・リソースは、式で属性を使用できるプラン・コンポーネント内のメジャーのリストを表示するために使用されます。
• ExpressionDetailTypeCode: string
  読取り専用: true

  最大長: 30

  式で使用されるエンティティのタイプまたはカテゴリを示すコード。 受け入れられる値のリストは、参照タイプORA_CN_EXPRESSION_DETAIL_TYPEにリストされます。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  読取り専用: true

  ビジネス・ユニットの一意の識別子。
• PlanComponentId: integer (int64)
  読取り専用: true

  プラン・コンポーネントの一意の識別子。
• PlanComponentName: string
  タイトル: Plan Component

  読取り専用: true

  最大長: 80

  プラン・コンポーネントの名前。
• PlanComponentResultAttribute: string
  タイトル: Plan Component Result Attribute

  読取り専用: true

  最大長: 240

  プラン・コンポーネントの属性。

{
    "type":"object",
    "properties":{
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeConfigId":{
            "type":"number",
            "description":"The unique identifier of the plan component's attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentResultAttribute":{
            "title":"Plan Component Result Attribute",
            "maxLength":240,
            "type":"string",
            "description":"The attribute of the plan component.",
            "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"
            }
        },
        "expressionDetailPlanComponentsMeasures":{
            "title":"Expression Detail Plan Component Measures",
            "type":"array",
            "description":"The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response"
            }
        },
        "ExpressionDetailTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 式詳細プラン・コンポーネント・メジャー

タイプ: array

タイトル: Expression Detail Plan Component Measures

プラン・コンポーネント・メジャー値リスト・リソースは、式で属性を使用できるプラン・コンポーネント内のメジャーのリストを表示するために使用されます。

ソースを表示

• Array of: object incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response

{
    "title":"Expression Detail Plan Component Measures",
    "type":"array",
    "description":"The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-item-response

タイプ: object

ソースを表示

• expressionDetailPlanComponentsMeasureResultAttributes: array Expression Detail Plan Component Measure Result Attributes
  タイトル: Expression Detail Plan Component Measure Result Attributes

  プラン・コンポーネント・メジャー結果属性値リスト・リソースは、式で使用できるプラン・コンポーネント内のパフォーマンス・メジャーの属性のリストを表示するために使用されます。
• ExpressionDetailTypeCode: string
  読取り専用: true

  最大長: 30

  式で使用されるエンティティのタイプまたはカテゴリのコード。 受け入れられる値のリストは、参照タイプORA_CN_EXPRESSION_DETAIL_TYPEにリストされます。
• FormulaId: integer (int64)
  読取り専用: true

  プラン・コンポーネントのパフォーマンス・メジャーの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  読取り専用: true

  ビジネス・ユニットの一意の識別子。
• PlanComponentId: integer (int64)
  読取り専用: true

  プラン・コンポーネントの一意の識別子。
• PlanComponentMeasureName: string
  タイトル: Performance Measure

  読取り専用: true

  最大長: 80

  プラン・コンポーネントのパフォーマンス・メジャーの名前。
• PlanComponentName: string
  タイトル: Plan Component

  読取り専用: true

  最大長: 80

  プラン・コンポーネントの名前。
• PlanComponentResultAttribute: string
  タイトル: Plan Component Result Attribute

  読取り専用: true

  最大長: 23

  プラン・コンポーネントの属性。

{
    "type":"object",
    "properties":{
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaId":{
            "type":"integer",
            "description":"The unique identifier of the plan component's performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentResultAttribute":{
            "title":"Plan Component Result Attribute",
            "maxLength":23,
            "type":"string",
            "description":"The attribute of the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expressionDetailPlanComponentsMeasureResultAttributes":{
            "title":"Expression Detail Plan Component Measure Result Attributes",
            "type":"array",
            "description":"The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionDetailTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentMeasureName":{
            "title":"Performance Measure",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component's performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 式詳細プラン・コンポーネント・メジャー結果属性

タイプ: array

タイトル: Expression Detail Plan Component Measure Result Attributes

プラン・コンポーネント・メジャー結果属性値リスト・リソースは、式で使用できるプラン・コンポーネント内のパフォーマンス・メジャーの属性のリストを表示するために使用されます。

ソースを表示

• Array of: object incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response

{
    "title":"Expression Detail Plan Component Measure Result Attributes",
    "type":"array",
    "description":"The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : incentiveCompensationExpressionDetailItemsLOV-expressionDetailPlanComponents-expressionDetailPlanComponentAttributes-expressionDetailPlanComponentsMeasures-expressionDetailPlanComponentsMeasureResultAttributes-item-response

タイプ: object

ソースを表示

• AttributeConfigId: integer (int64)
  読取り専用: true

  プラン・コンポーネントのパフォーマンス・メジャー属性の一意の識別子です。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  読取り専用: true

  ビジネス・ユニットの一意の識別子。
• PlanComponentMeasureResultAttribute: string
  タイトル: Plan Component Measure Result Attribute

  読取り専用: true

  最大長: 60

  プラン・コンポーネントのパフォーマンス・メジャーの属性。

{
    "type":"object",
    "properties":{
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentMeasureResultAttribute":{
            "title":"Plan Component Measure Result Attribute",
            "maxLength":60,
            "type":"string",
            "description":"The plan component's performance measure's attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeConfigId":{
            "type":"integer",
            "description":"The unique identifier of the plan component's performance measure attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

リンク

expressionDetailPlanComponentsMeasures

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures

パラメータ:

• expressionDetailPlanComponentAttributesUniqID: $request.path.expressionDetailPlanComponentAttributesUniqID
• expressionDetailPlanComponentsUniqID: $request.path.expressionDetailPlanComponentsUniqID
• incentiveCompensationExpressionDetailItemsLOVUniqID: $request.path.incentiveCompensationExpressionDetailItemsLOVUniqID

(expressionDetailPlanComponentsMeasuresのリソース)

「トップに戻る」