機械翻訳について

ジャンプ先

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

ロールの更新

patch

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}

リクエスト

パス・パラメータ

• CompensationPlanId(required): integer(int64)
  報酬プランの一意の識別子。
• CompensationPlanRolesUniqID(required): string
  これは、報酬プランの複合キー(RolePlanIdおよびCompensationPlanId ---)を構成する属性のハッシュ・キーです - ロール・リソースであり、報酬プランのインスタンスを一意に識別するために使用されます - Roles. クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは報酬プランを問い合せる必要があります - 報酬プランの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを持つロール収集リソース - Roles.
  
  次に例を示します: CompensationPlanRoles?q=RolePlanId=<value1>;CompensationPlanId=<value2>

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• CompensationPlanId: integer (int64)
  報酬プランの一意の識別子です。
• EndDate: 文字列(日付)
  タイトル: End Date

  報酬プランのロール割当が非アクティブになる日付。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。
• StartDate: 文字列(日付)
  タイトル: Start Date

  報酬プランのロール割当がアクティブになる日付。 許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : compensationPlans-CompensationPlanRoles-item-response

タイプ: object

ソースを表示

• CompensationPlanId: integer (int64)
  報酬プランの一意の識別子です。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• EndDate: 文字列(日付)
  タイトル: End Date

  報酬プランのロール割当が非アクティブになる日付。 許容可能な書式はyyyy-mm-ddです。 日付を割り当てた後は、NULLに更新できません。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• links: array Links
  タイトル: Links

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

  読取り専用: true

  最大長: 120

  ロールの作成時にユーザーが入力したロールの説明。
• RoleId: integer (int64)
  ロールの一意の識別子。
• RoleName: string
  タイトル: Role Name

  読取り専用: true

  最大長: 60

  ロールの名前。
• RolePlanId: integer (int64)
  プランに関連付けられたロールの一意の識別子。
• StartDate: 文字列(日付)
  タイトル: Start Date

  報酬プランのロール割当がアクティブになる日付。 許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"The description of the role entered by the user while creating the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier for a role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RolePlanId":{
            "type":"integer",
            "description":"The unique identifier for the role associated with a plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

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

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

リンク

RoleVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles

ロールの一意の識別子を含む値リスト。

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

• ソース属性: RoleId;ターゲット属性: RoleId
• 表示属性: AccessType, RoleName, RoleDescription

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行してロールを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans/300100090306794/child/CompensationPlanRoles/00020000000EACED00057708000110F07F4A46A80000000EACED00057708000110F07F47A0EA

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"StartDate" : "2016-01-02"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "RolePlanId": 300100090480296,
  "RoleId": 100000015115351,
  "StartDate": "2016-01-02",
  "EndDate": "2016-12-31",
  "RoleDescription": "US Sales Executive",
  "RoleName": "US Sales Executive",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-07T08:07:38-07:00",
  "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA",
  "LastUpdateDate": "2017-06-07T08:24:12-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CompensationPlanId": 300100090306794,
  "links": [
    ...
  ]
}

「トップに戻る」