Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての支払グループの取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups

リクエスト

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定された主キーを持つ支払グループを検索します。
  ファインダ変数:
  - PayGroupId; integer;支払グループの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string;支払グループを作成したユーザー。
- CreationDate; string;支払グループが作成された日時。
- 説明;文字列;支払グループの簡単な説明。
- EndDate; string; 支給グループが非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
- LastUpdateDate; string;支払グループが最後に更新された日時。
- LastUpdatedBy; string; 支払グループを最後に更新したユーザー。
- OrgId; integer; 支払グループが属するビジネス・ユニットの一意の識別子。「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
- PayGroupId; integer;支払グループの一意の識別子。
- PayGroupName; string;インセンティブ報酬支払グループの名前。名前とビジネス・ユニットの組合せは一意である必要があります。
- PayGroupType;文字列。給与や買掛管理など、支給グループのタイプを示すコード。指定可能な値は、ORACLE_PAYROLLおよびORACLE_APです。受理可能な値のリストは、参照CN_PAY_GROUP_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- StartDate; string; 支給グループがアクティブになる日付。許容可能な書式はyyyy-mm-ddです。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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

ルート・スキーマ : incentiveCompensationPayGroups

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPayGroups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object incentiveCompensationPayGroups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPayGroups-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"
    }
}

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

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

支給グループを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

支給グループが作成された日時です。
Description: string

タイトル: Pay Group Description

最大長: 999

支給グループの簡単な説明。
EndDate: 文字列(日付)

タイトル: End Date

支給グループが非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
LastUpdateDate: string (date-time)

読取り専用: true

支給グループが最後に更新された日時です。
LastUpdatedBy: string

読取り専用: true

最大長: 64

支給グループを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Business Unit

支給グループが属するビジネス・ユニットの一意のID。「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
PayGroupAssignments: array Pay Group Assignments

タイトル: Pay Group Assignments

支給グループ割当リソースは、支給グループのインセンティブ報酬割当を表示、作成、更新または削除するために使用されます。
PayGroupId: integer (int64)

支給グループの一意の識別子。
PayGroupName: string

タイトル: Name

最大長: 80

インセンティブ報酬支払グループの名前。名前とビジネス・ユニットの組合せは一意である必要があります。
PayGroupRoles: array Pay Group Roles

タイトル: Pay Group Roles

支給グループ・ロール・リソースは、支払グループに対するインセンティブ報酬ロール割当を表示、作成、更新および削除するために使用されます。
PayGroupType: string

タイトル: Pay Group Type

最大長: 30

給与や買掛管理など、支払グループのタイプを示すコード。指定可能な値は、ORACLE_PAYROLLおよびORACLE_APです。受理可能な値のリストは、参照CN_PAY_GROUP_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
StartDate: 文字列(日付)

タイトル: Start Date

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the pay group is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Pay Group Description",
            "maxLength":999,
            "type":"string",
            "description":"A brief description of the pay group.",
            "nullable":true,
            "x-queryable":true
        },
        "PayGroupAssignments":{
            "title":"Pay Group Assignments",
            "type":"array",
            "description":"The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupAssignments-item-response"
            }
        },
        "PayGroupRoles":{
            "title":"Pay Group Roles",
            "type":"array",
            "description":"The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupRoles-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the pay group becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayGroupName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the incentive compensation pay group. The combination of the name and business unit must be unique.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the pay group becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the pay group belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "PayGroupType":{
            "title":"Pay Group Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of pay group, for example, for payroll or for payables. Possible values include ORACLE_PAYROLL and ORACLE_AP.  A list of acceptable values is defined in the lookup CN_PAY_GROUP_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the pay group 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"
    }
}

ネストされたスキーマ : 支払グループ割当

タイプ: array

タイトル: Pay Group Assignments

支給グループ割当リソースは、支給グループのインセンティブ報酬割当を表示、作成、更新または削除するために使用されます。

ソースを表示

Array of: object incentiveCompensationPayGroups-PayGroupAssignments-item-response

{
    "title":"Pay Group Assignments",
    "type":"array",
    "description":"The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupAssignments-item-response"
    }
}

ネストされたスキーマ : 支払グループ・ロール

タイプ: array

タイトル: Pay Group Roles

支給グループ・ロール・リソースは、支払グループに対するインセンティブ報酬ロール割当を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object incentiveCompensationPayGroups-PayGroupRoles-item-response

{
    "title":"Pay Group Roles",
    "type":"array",
    "description":"The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupRoles-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."
        }
    }
}

ネストされたスキーマ : incentiveCompensationPayGroups-PayGroupAssignments-item-response

タイプ: object

ソースを表示

AnalystId: integer (int64)

タイトル: Analyst

読取り専用: true

支給グループに割り当てられたアナリストの一意の識別子。
AnalystName: string

タイトル: Analyst Name

読取り専用: true

最大長: 360

支給グループに割り当てられているアナリストの名前。
AssignmentType: string

タイトル: Assignment Type

読取り専用: true

支給グループの割当タイプ。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

支給グループ割当を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

支給グループ割当が作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

支給グループの割当が非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

支給グループ割当が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

支給グループ割当を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ParticipantId: integer (int64)

タイトル: Participant Identifier

関係者の一意の識別子。
ParticipantName: string

タイトル: Participant Name

読取り専用: true

最大長: 360

インセンティブ報酬の関係者の名前。
ParticipantPayGroupId: integer (int64)

参加者支払グループ割当レコードの一意の識別子。
PersonNumber: string

タイトル: Person Number

読取り専用: true

最大長: 30

企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。国別識別子コンポーネントとの関連はありません。
RoleId: integer (int64)

読取り専用: true

支給グループ・ロールの一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
StartDate: 文字列(日付)

タイトル: Start Date

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

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the pay group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the pay group assignment is 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 pay group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the pay group role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the participant pay group assignment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the assignment 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
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to the pay group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The assignment type for the pay group.",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the pay group assignment 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"
    }
}

ネストされたスキーマ : incentiveCompensationPayGroups-PayGroupRoles-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

支給グループ・ロール割当を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

支給グループ・ロール割当が作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

支給グループのロール割当が非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。日付は、支給グループの終了日以前の日付にする必要があります。デフォルト値は支給グループの終了日です。
LastUpdateDate: string (date-time)

読取り専用: true

支給グループ・ロール割当が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

支払グループ・ロール割当を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PayGroupId: integer (int64)

支給グループの一意の識別子。
RoleDescription: string

タイトル: Role Description

読取り専用: true

最大長: 120

支給グループ・ロールの簡単な説明。
RoleId: integer (int64)

タイトル: Name

支給グループ・ロールの一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

支給グループ・ロールの名前。
RolePayGroupId: integer (int64)

支給グループに関連付けられたロールの一意の識別子です。
StartDate: 文字列(日付)

タイトル: Start Date

支給グループのロール割当がアクティブになる日付。許容可能な書式はyyyy-mm-ddです。日付は、支給グループの開始日以降にする必要があります。デフォルト値は支給グループの開始日です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the pay group role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolePayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"A brief description of the pay group role.",
            "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"
            }
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a pay group role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment 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"
    }
}

「トップに戻る」