Get many distribution rules within a version
get
/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules
Request
Path Parameters
-
LaborScheduleId(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=
-
versionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Person Assignment Labor Schedule Versions resource and used to uniquely identify an instance of Person Assignment Labor Schedule Versions. The client should not generate the hash key value. Instead, the client should query on the Person Assignment Labor Schedule Versions collection resource in order to navigate to a specific instance of Person Assignment Labor Schedule Versions to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
finder: string
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 the distribution rule within the version with the specified primary key.
Finder Variables- DistributionRuleId; integer; The unique identifier of the labor schedule distribution rule.
- LineNumber; integer; The secondary unique identifier for the labor schedule distribution rule.
- PrimaryKey Finds the distribution rule within the version with the specified primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- BillableFlag; boolean; Identifies if the charge is billable or not.
- CapitalizableFlag; boolean; Information that indicates if a project-related item is eligible for capitalization.
- ChartOfAccountsId; integer; GL Account for this distribution, if the rule is to a GL account.
- ContextCategory; string; Identifies the descriptive flexfield application context for project-related standardized cost collection.
- ContractId; integer; Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management.
- ContractLineId; integer; Tracks contract line information. Not used currently.
- ContractName; string; Name associated to the contract ID.
- ContractNumber; string; Number associated to the contract ID.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date the record was created.
- DistributionRuleId; integer; Primary key of distribution rule concatenated with the Line Number to make it unique.
- ExpenditureItemDate; string; Date on which a project-related transaction is incurred.
- ExpenditureOrganizationId; integer; Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions.
- ExpenditureOrganizationName; string; Name for expenditure organization.
- ExpenditureTypeId; integer; Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions.
- ExpenditureTypeName; string; Name of the expenditure type for this cost distribution.
- FundingAllocationId; integer; Specifies the name of the project funding override. Not used currently.
- FundingSourceId; string; Identifier of the funding source for this distribution.
- FundingSourceName; string; Funding source name.
- FundingSourceNumber; string; Funding source number associated to this distribution.
- GLAccount; string; GL Account for this distribution, if the rule is to a GL account.
- GLAccountCombinationId; integer; The GL Account code combination identifier, if the rule is set to a GL account.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- LineNumber; integer; Primary key of distribution rule concatenated with the DistributionRuleID to make it unique.
- LinePercent; number; The percentage for this distribution rule, to be applied to the total cost for distribution.
- ProjectId; integer; Identifier of the project for this distribution rule, if it's a project distribution.
- ProjectName; string; Name of the project associated to this distribution if it's a project distribution.
- ProjectNumber; string; Number of the project associated to this distribution if it's a project distribution.
- TaskId; integer; Identifier of the task for this distribution rule, if it's a project distribution.
- TaskName; string; Name of the task associated to this distribution if it's a project distribution.
- TaskNumber; string; Task number associated with this distribution.
- WorkTypeId; integer; Identifier for project-related classification of the worked performed.
- WorkTypeName; string; Name for project-related classification of the worked performed.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : personAssignmentLaborSchedules-versions-distributionRules
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personAssignmentLaborSchedules-versions-distributionRules-item-response
Type:
Show Source
object
-
BillableFlag: boolean
Maximum Length:
1
Identifies if the charge is billable or not. -
CapitalizableFlag: boolean
Maximum Length:
1
Information that indicates if a project-related item is eligible for capitalization. -
ChartOfAccountsId: integer
GL Account for this distribution, if the rule is to a GL account.
-
ContextCategory: string
Maximum Length:
40
Default Value:PJC_Labor_Distribution
Identifies the descriptive flexfield application context for project-related standardized cost collection. -
ContractId: integer
(int64)
Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management.
-
ContractLineId: integer
(int64)
Tracks contract line information. Not used currently.
-
ContractName: string
Title:
Contract Name
Maximum Length:300
Name associated to the contract ID. -
ContractNumber: string
Title:
Contract Number
Maximum Length:120
Number associated to the contract ID. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date the record was created. -
DistributionRuleId: integer
(int64)
Primary key of distribution rule concatenated with the Line Number to make it unique.
-
ExpenditureItemDate: string
(date-time)
Date on which a project-related transaction is incurred.
-
ExpenditureOrganizationId: integer
(int64)
Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions.
-
ExpenditureOrganizationName: string
Title:
Expenditure Organization
Maximum Length:240
Name for expenditure organization. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type
Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Name of the expenditure type for this cost distribution. -
FundingAllocationId: integer
(int64)
Specifies the name of the project funding override. Not used currently.
-
FundingSourceId: string
Maximum Length:
150
Identifier of the funding source for this distribution. -
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Funding source name. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding source number associated to this distribution. -
GLAccount: string
GL Account for this distribution, if the rule is to a GL account.
-
GLAccountCombinationId: integer
(int64)
The GL Account code combination identifier, if the rule is set to a GL account.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LineNumber: integer
Primary key of distribution rule concatenated with the DistributionRuleID to make it unique.
-
LinePercent: number
Default Value:
0
The percentage for this distribution rule, to be applied to the total cost for distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Identifier of the project for this distribution rule, if it's a project distribution.
-
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project associated to this distribution if it's a project distribution. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of the project associated to this distribution if it's a project distribution. -
TaskId: integer
(int64)
Title:
Task
Identifier of the task for this distribution rule, if it's a project distribution. -
TaskName: string
Title:
Task Name
Maximum Length:255
Name of the task associated to this distribution if it's a project distribution. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Task number associated with this distribution. -
WorkTypeId: integer
(int64)
Identifier for project-related classification of the worked performed.
-
WorkTypeName: string
Title:
Work Type
Read Only:true
Maximum Length:240
Name for project-related classification of the worked performed.
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.