Get many pay element expenditure type derivation patterns

get

/fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds pay element expenditure type derivations based on the unique identifier associated with the object.
      Finder Variables
      • ExpenditureTypeDerivPatternId; integer; The pay element expenditure type derivation unique identifier used in the primary key finder.
    • findByExpenditureType Finds pay element expenditure type derivations for a given expenditure type.
      Finder Variables
      • expenditureTypeName; string; Finds pay element expenditure type derivation patterns for a given expenditure type name.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; Created By
    • CreationDate; string; Creation Date
    • ElementType; string; Pay element code.
    • ElementTypeId; string; Pay element unique identifier.
    • ElementTypeName; string; Name of the pay element.
    • ExpenditureTypeDerivPatternDescription; string; Free-form description of the expenditure type derivation pattern.
    • ExpenditureTypeDerivPatternEnd; string; End date of the expenditure type derivation pattern.
    • ExpenditureTypeDerivPatternId; integer; Unique identifier of the expenditure type derivation pattern.
    • ExpenditureTypeDerivPatternName; string; Free-form name of the expenditure type derivation pattern.
    • ExpenditureTypeDerivPatternStart; string; Start date of the expenditure type derivation pattern.
    • ExpenditureTypeDerivPatternStatus; string; 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; The code associated with the status of the expenditure type derivation pattern.
    • LastUpdateDate; string; Last Updated By
    • LastUpdatedBy; string; Last Updated Date
    • LegislationCode; string; Legislation Code
    • LegislativeDataGroupId; integer; Unique identifier of the legislative data group for the pay element.
    • LegislativeDataGroupName; string; Legislative Data Group
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : payElementExpenditureTypeDerivations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : payElementExpenditureTypeDerivations-item-response
Type: object
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 : payElementExpenditureTypeDerivations-precedenceRules-item-response
Type: object
Show Source
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-response
Type: object
Show Source
Back to Top