Create pay elements eligible for project distribution.
post
/fscmRestApi/resources/11.13.18.05/projectPayElements
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Comments: string
Maximum Length:
4000
Free-form comments associated with the pay element eligible for project distribution. -
DistributeEndDate: string
(date)
End of the time period when the pay element is eligible for project distribution.
-
DistributeStartDate: string
(date)
Start of the time period when the pay element is eligible for project distribution.
-
LegislationCode: string
Legislation Code
-
LegislativeDataGroupId: integer
The unique identifier of the legislative data group of the pay element eligible for project distribution.
-
LegislativeDataGroupName: string
Legislative Data Group
-
PayElement: string
Maximum Length:
80
Pay Element -
PayElementDistributionId: integer
(int64)
The unique identifier of the pay element eligible for project distribution.
-
PayElementName: string
Maximum Length:
80
Pay Element Name -
PayElementTypeId: integer
(int64)
The unique identifier of a pay element from the pay element source table.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPayElements-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
4000
Free-form comments associated with the pay element eligible for project distribution. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
DistributeEndDate: string
(date)
End of the time period when the pay element is eligible for project distribution.
-
DistributeStartDate: string
(date)
Start of the time period when the pay element is eligible for project distribution.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
LegislationCode: string
Legislation Code
-
LegislativeDataGroupId: integer
The unique identifier of the legislative data group of the pay element eligible for project distribution.
-
LegislativeDataGroupName: string
Legislative Data Group
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayElement: string
Maximum Length:
80
Pay Element -
PayElementDistributionId: integer
(int64)
The unique identifier of the pay element eligible for project distribution.
-
PayElementName: string
Maximum Length:
80
Pay Element Name -
PayElementTypeId: integer
(int64)
The unique identifier of a pay element from the pay element source table.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.