Update a pay element expenditure type derivation pattern
patch
/fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}
Request
Path Parameters
-
ExpenditureTypeDerivPatternId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ExpenditureTypeDerivPatternDescription: string
Maximum Length:
2000
Free-form description of the expenditure type derivation pattern. -
ExpenditureTypeDerivPatternEnd: string
(date)
End date of the expenditure type derivation pattern.
-
ExpenditureTypeDerivPatternName: string
Maximum Length:
200
Free-form name of the expenditure type derivation pattern. -
ExpenditureTypeDerivPatternStart: string
(date)
Start date of the expenditure type derivation pattern.
-
ExpenditureTypeDerivPatternStatus: string
Maximum Length:
255
The status of the expenditure type derivation pattern that defines whether it should be applied for projects costs with an expenditure item date between the specified date range. -
ExpenditureTypeDerivPatternStatusCode: string
Maximum Length:
30
The code associated with the status of the expenditure type derivation pattern. -
precedenceRules: array
Pay Element to Expenditure Type Derivation Precedence Rules
Title:
Pay Element to Expenditure Type Derivation Precedence Rules
The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects.
Nested Schema : Pay Element to Expenditure Type Derivation Precedence Rules
Type:
array
Title:
Pay Element to Expenditure Type Derivation Precedence Rules
The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects.
Show Source
Nested Schema : payElementExpenditureTypeDerivations-precedenceRules-item-patch-request
Type:
Show Source
object
-
DerivSetDescription: string
Maximum Length:
2000
Free-form description of the expenditure type derivation precedence set. -
DerivSetName: string
Maximum Length:
200
Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern. -
expenditureTypes: array
Pay Element to Expenditure Type Results
Title:
Pay Element to Expenditure Type Results
The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.
Nested Schema : Pay Element to Expenditure Type Results
Type:
array
Title:
Pay Element to Expenditure Type Results
The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.
Show Source
Nested Schema : payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-patch-request
Type:
Show Source
object
-
ExpenditureTypeId: integer
(int64)
The unique identifier of the expenditure type.
-
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
The name of the expenditure type.
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 : payElementExpenditureTypeDerivations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
ElementType: string
Maximum Length:
80
Pay element code. -
ElementTypeId: string
Maximum Length:
150
Pay element unique identifier. -
ElementTypeName: string
Maximum Length:
80
Name of the pay element. -
ExpenditureTypeDerivPatternDescription: string
Maximum Length:
2000
Free-form description of the expenditure type derivation pattern. -
ExpenditureTypeDerivPatternEnd: string
(date)
End date of the expenditure type derivation pattern.
-
ExpenditureTypeDerivPatternId: integer
(int64)
Read Only:
true
Unique identifier of the expenditure type derivation pattern. -
ExpenditureTypeDerivPatternName: string
Maximum Length:
200
Free-form name of the expenditure type derivation pattern. -
ExpenditureTypeDerivPatternStart: string
(date)
Start date of the expenditure type derivation pattern.
-
ExpenditureTypeDerivPatternStatus: string
Maximum Length:
255
The status of the expenditure type derivation pattern that defines whether it should be applied for projects costs with an expenditure item date between the specified date range. -
ExpenditureTypeDerivPatternStatusCode: string
Maximum Length:
30
The code associated with the status of the expenditure type derivation pattern. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
LegislationCode: string
Read Only:
true
Maximum Length:30
Legislation Code -
LegislativeDataGroupId: integer
(int64)
Read Only:
true
Unique identifier of the legislative data group for the pay element. -
LegislativeDataGroupName: string
Read Only:
true
Maximum Length:240
Legislative Data Group -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
precedenceRules: array
Pay Element to Expenditure Type Derivation Precedence Rules
Title:
Pay Element to Expenditure Type Derivation Precedence Rules
The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pay Element to Expenditure Type Derivation Precedence Rules
Type:
array
Title:
Pay Element to Expenditure Type Derivation Precedence Rules
The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects.
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.
Nested Schema : payElementExpenditureTypeDerivations-precedenceRules-item-response
Type:
Show Source
object
-
DerivSetDescription: string
Maximum Length:
2000
Free-form description of the expenditure type derivation precedence set. -
DerivSetName: string
Maximum Length:
200
Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern. -
ExpenditureTypeDerivPatternId: integer
(int64)
Unique identifier of the expenditure type derivation pattern associated with this precedence set.
-
expenditureTypes: array
Pay Element to Expenditure Type Results
Title:
Pay Element to Expenditure Type Results
The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Precedence: integer
(int32)
Read Only:
true
Default Value:1
The precedence number that defines the order in which this set should be applied when the payroll cost is being distributed to projects and the pay element matches the pattern. -
PrecedenceId: integer
(int64)
Read Only:
true
The unique identifier of the precedence rule.
Nested Schema : Pay Element to Expenditure Type Results
Type:
array
Title:
Pay Element to Expenditure Type Results
The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-response
Type:
Show Source
object
-
DerivResultNumber: integer
(int32)
Read Only:
true
Default Value:1
Autogenerated number as a counter within the precedence rule. There must be only one for this type of pattern. -
ExpenditureCategoryId: integer
(int64)
Read Only:
true
Unique identifier of the expenditure category associated with the expenditure type. -
ExpenditureCategoryName: string
Title:
Expenditure Category
Read Only:true
Maximum Length:240
Name of the expenditure category associated with this expenditure type. -
ExpenditureFromDate: string
(date)
Title:
From Date
Read Only:true
The date from which this expenditure type is allowed to be used in projects. -
ExpenditureToDate: string
(date)
Title:
To Date
Read Only:true
The date to which this expenditure type is allowed to be used in projects. -
ExpenditureTypeId: integer
(int64)
The unique identifier of the expenditure type.
-
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
The name of the expenditure type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrecedenceId: integer
(int64)
The unique identifier of the precedence set associated with this expenditure type result.
-
ResultId: integer
(int64)
Read Only:
true
The unique identifier of the result.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- precedenceRules
-
Parameters:
- ExpenditureTypeDerivPatternId:
$request.path.ExpenditureTypeDerivPatternId
The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects. - ExpenditureTypeDerivPatternId: