機械翻訳について

ジャンプ先

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

インセンティブ報酬ロールの更新

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}

リクエスト

パス・パラメータ

• RoleId(required): integer(int64)
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AccessType: string
  タイトル: Access Type

  最大長: 30

  デフォルト値: INDIVIDUAL
• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true
• RoleDescription: string
  タイトル: Role Description

  最大長: 120
• RoleName: string
  タイトル: Name

  最大長: 60
• RoleParticipants: array Role - Participants
  タイトル: Role - Participants

  ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。

{
    "type":"object",
    "properties":{
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"",
            "nullable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false
        },
        "RoleParticipants":{
            "title":"Role - Participants",
            "type":"array",
            "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-patch-request"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":false,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : ロール - 参加者

タイプ: array

タイトル: Role - Participants

ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Role - Participants",
    "type":"array",
    "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• EndDateActive: 文字列(日付)
  タイトル: Assignment End Date
• PreserveRoleAssignmentFlag: boolean
  タイトル: Preserve Assignment
• StartDateActive: 文字列(日付)
  タイトル: Assignment Start Date

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":false
        },
        "EndDateActive":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : incentiveCompensationRoles-item-response

タイプ: object

ソースを表示

• AccessType: string
  タイトル: Access Type

  最大長: 30

  デフォルト値: INDIVIDUAL
• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true
• 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

  最大長: 120
• RoleId: integer (int64)
• RoleName: string
  タイトル: Name

  最大長: 60
• RoleParticipants: array Role - Participants
  タイトル: Role - Participants

  ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleParticipants":{
            "title":"Role - Participants",
            "type":"array",
            "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-response"
            }
        },
        "RoleId":{
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":false,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"",
            "nullable":true,
            "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"
    }
}

ネストされたスキーマ : ロール - 参加者

タイプ: array

タイトル: Role - Participants

ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object incentiveCompensationRoles-RoleParticipants-item-response

{
    "title":"Role - Participants",
    "type":"array",
    "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-response"
    }
}

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

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

ネストされたスキーマ : incentiveCompensationRoles-RoleParticipants-item-response

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  読取り専用: true

  最大長: 1
• AnalystName: string
  タイトル: Analyst

  読取り専用: true

  最大長: 360
• CompensationEndDate: 文字列(日付)
  タイトル: Compensation End Date

  読取り専用: true
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true
• EndDateActive: 文字列(日付)
  タイトル: Assignment End Date
• HoldPaymentFlag: boolean
  タイトル: Hold payment

  読取り専用: true

  最大長: 1
• HRPersonNumber: string
  タイトル: Person Number

  読取り専用: true

  最大長: 30
• HRPrimaryWorkerNumber: string
  タイトル: Worker Number

  読取り専用: true

  最大長: 30
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  タイトル: Business Unit

  読取り専用: true
• ParticipantId: integer (int64)
  タイトル: Participant Name
• ParticipantName: string
  タイトル: Participant Name

  読取り専用: true

  最大長: 360
• ParticipantRoleId: integer (int64)
• ParticipantType: string
  タイトル: Type

  読取り専用: true

  最大長: 60
• PartyNumber: string
  タイトル: Party Number

  読取り専用: true

  最大長: 30
• PayeeOnly: string
  タイトル: Payee Only

  読取り専用: true

  最大長: 1
• PreserveRoleAssignmentFlag: boolean
  タイトル: Preserve Assignment
• RoleId: integer (int64)
  タイトル: Name
• StartDateActive: 文字列(日付)
  タイトル: Assignment Start Date

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HRPrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeOnly":{
            "title":"Payee Only",
            "maxLength":1,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantRoleId":{
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldPaymentFlag":{
            "title":"Hold payment",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst",
            "maxLength":360,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Name",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"",
            "nullable":true,
            "x-queryable":true
        },
        "CompensationEndDate":{
            "title":"Compensation End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ParticipantId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HRPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"",
            "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"
    }
}

リンク

CnLookupAccessTypeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

CnLookupYesNoVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

RoleParticipants

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants

パラメータ:

• RoleId: $request.path.RoleId

ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。

トップに戻る

例:

次の例は、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/incentiveCompensationRoles/300100089785736/

リクエスト本文の例

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

{
  "RoleName": "Sales Representative Role",
  "ActiveFlag": false
}

レスポンス本文の例

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

{
  "RoleName": "Sales Representative Role",
  "ActiveFlag": false,
  "RoleId": 300100089785736,
  "RoleDescription": "This role consists of sales members on the ground",
  "CreatedBy": "OIC_MGR_OPERATIONS",
  "CreationDate": "2017-03-16T17:16:44+05:30",
  "LastUpdatedBy": "OIC_MGR_OPERATIONS",
  "LastUpdateDate": "2017-03-16T19:26:39+05:30",
  "LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
  "AccessType": "INDIVIDUAL",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
      "name": "roles",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
      "name": "roles",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupYesNoVO",
      "name": "CnLookupYesNoVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupAccessTypeVO",
      "name": "CnLookupAccessTypeVO",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants",
      "name": "RoleParticipants",
      "kind": "collection"
    }
  ]
}

「トップに戻る」