機械翻訳について

ジャンプ先

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

直接割当リクエストの作成

post

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests

リクエスト

パス・パラメータ

• CompensationPlanId(required): integer(int64)
  報酬プランの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• CompensationPlanId: integer (int64)
  基本報酬プランの一意の識別子です。
• EndDate: 文字列(日付)
  直接割当リクエストが非アクティブになる日付。
• ErrorReason: string
  最大長: 240

  報酬プランのデプロイ・プロセスがリクエストを否認した事由です。 レコードが処理されている場合、この属性は移入されません。
• ParticipantId: integer (int64)
  関係者の一意の識別子。
• RequestCreateFlag: boolean
  直接割当リクエストを作成する必要があるかどうかを示します。
• RequestDeleteFlag: boolean
  直接割当リクエストを削除する必要があるかどうかを示します。 フラグがYに設定されていて、削除が機能しない場合は、フラグをTrueに設定する必要があります。
• RequestEditFlag: boolean
  直接割当リクエストを編集する必要があるかどうかを示します。
• SrpCompPlanId: integer (int64)
  報酬プランの一意の識別子。
• StartDate: 文字列(日付)
  直接割当リクエストがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes active.",
            "format":"date",
            "nullable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequestCreateFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be created.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorReason":{
            "maxLength":240,
            "type":"string",
            "description":"The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "RequestEditFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be edited.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CompensationPlanId: integer (int64)
  基本報酬プランの一意の識別子です。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  直接割当リクエストを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  直接割当リクエストが作成された日時。
• EndDate: 文字列(日付)
  直接割当リクエストが非アクティブになる日付。
• ErrorReason: string
  最大長: 240

  報酬プランのデプロイ・プロセスがリクエストを否認した事由です。 レコードが処理されている場合、この属性は移入されません。
• LastUpdateDate: string (date-time)
  読取り専用: true

  直接割当リクエストが最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  直接割当リクエストを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ParticipantId: integer (int64)
  関係者の一意の識別子。
• ParticipantName: string
  タイトル: Name

  読取り専用: true

  最大長: 360

  参加者の名前。
• ParticipantPlanNumber: string
  読取り専用: true

  最大長: 30

  参加者プランの代替キー識別子。
• PlanDirectAssignmentRequestId: integer (int64)
  読取り専用: true

  直接割当リクエストの一意の識別子。
• ProcessingStatus: string
  読取り専用: true

  リクエストの作成、リクエストの作成完了、リクエストの作成失敗、リクエストの編集、リクエストの更新完了、リクエストの更新失敗、リクエストの削除、リクエストの削除完了またはリクエストの削除失敗など、リクエストのステージを指定する参加者直接割当リクエストの処理ステータス。 許容可能な値のリストは、参照ORA_CN_PRT_DRCT_ASGN_RQ_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• ProcessRequestId: integer (int64)
  読取り専用: true

  リクエストを選択した報酬プランのデプロイ・プロセスのリクエストの一意の識別子。
• RequestCreateFlag: boolean
  直接割当リクエストを作成する必要があるかどうかを示します。
• RequestDeleteFlag: boolean
  直接割当リクエストを削除する必要があるかどうかを示します。 フラグがYに設定されていて、削除が機能しない場合は、フラグをTrueに設定する必要があります。
• RequestEditFlag: boolean
  直接割当リクエストを編集する必要があるかどうかを示します。
• SrpCompPlanId: integer (int64)
  報酬プランの一意の識別子。
• StartDate: 文字列(日付)
  直接割当リクエストがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanDirectAssignmentRequestId":{
            "type":"integer",
            "description":"The unique identifier of the direct assignment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestCreateFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be created.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessRequestId":{
            "type":"integer",
            "description":"The unique identifier of the request of the Deploy Compensation Plan process that picked up the request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":240,
            "type":"string",
            "description":"The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantPlanNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "type":"string",
            "description":"The processing status of the participant direct assignment request specifying the stage the request is in, such as Create requested, Create request completed, Create request failed, Edit requested, Update request completed, Update request failed, Delete requested, Delete request completed, or Delete request failed. A list of acceptable values is defined in the lookup ORA_CN_PRT_DRCT_ASGN_RQ_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestEditFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be edited.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

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

リンク

CnLookupProcessingStatus

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

関係者直接割当リクエストの処理ステータスを示す値リスト。

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

• ソース属性: ProcessingStatus;ターゲット属性: LookupCode
• 表示属性: 意味

CompensationPlanAssignments

操作: /fscmRestApi/resources/11.13.18.05/compensationPlans

参加者報酬プランの一意の識別子を含む値リスト。

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

• ソース属性: SrpCompPlanId;ターゲット属性: SrpCompPlanId
• 表示属性: AnalystName, ParticipantName, ParticipantId, SrpCompPlanId, StartDate, EndDate

ParticipantVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV

パラメータ:

• ファインダ: SearchActiveParticipant

関係者の一意の識別子を含む値リスト。

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

• ソース属性: ParticipantId;ターゲット属性: ParticipantId
• 表示属性: ParticipantName, PersonNumber, AnalystName

「トップに戻る」