Get all Cost Rate Override details
get
/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides
Request
Query Parameters
-
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 all the overrides with the specified Rate override ID.
Finder Variables- RateOverrideId; integer; The unique identifier of the rate Override.
- PrimaryKey Finds all the overrides with the specified Rate override ID.
-
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:- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CurrencyCode; string; Currency code associated with the rate override.
- CurrencyName; string; Currency name associated with the rate override.
- ExpenditureTypeId; integer; Identifier of the expenditure type to which the rate override belongs.
- ExpenditureTypeName; string; Name of the expenditure type to which the rate override belongs.
- FromDate; string; Date from which the rate override is effective. The date format is YYYY-MM-DD.
- JobCode; string; Code of the job to which the rate override belongs.
- JobId; integer; Identifier of the job to which the rate override belongs.
- JobName; string; Name of the job to which the rate override belongs.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- PersonEmail; string; Email of the person to which the rate override belongs.
- PersonId; integer; Identifier of the person to which the rate override belongs.
- PersonName; string; Name of the person to which the rate override belongs.
- PersonNumber; string; Number of the person to which the rate override belongs.
- ProjectId; integer; Identifier of the project to which the rate override belongs.
- ProjectName; string; Name of the project to which the rate override belongs.
- ProjectNumber; string; Number of the project to which the rate override belongs.
- Rate; number; The rate assigned to the rate override.
- RateOverrideId; integer; The unique identifier of the rate override.
- RateOverrideReason; string; The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type.
- RateOverrideReasonCode; string; The reason code for changing the rate override.
- TaskId; integer; Identifier of the task to which the rate override belongs.
- TaskName; string; Name of the task to which the rate override belongs.
- TaskNumber; string; Number of the task to which the rate override belongs.
- ToDate; string; Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.
-
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:
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 : projectandTaskCostRateOverrides
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 : projectandTaskCostRateOverrides-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Currency code associated with the rate override. -
CurrencyName: string
Title:
Currency Name
Maximum Length:255
Currency name associated with the rate override. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type to which the rate override belongs. -
ExpenditureTypeName: string
Title:
Expenditure Type Name
Name of the expenditure type to which the rate override belongs. -
FromDate: string
(date)
Title:
From Date
Date from which the rate override is effective. The date format is YYYY-MM-DD. -
JobCode: string
Title:
Job Code
Maximum Length:255
Code of the job to which the rate override belongs. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job to which the rate override belongs. -
JobName: string
Title:
Job Name
Name of the job to which the rate override belongs. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Update By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonEmail: string
Title:
Person Email
Maximum Length:255
Email of the person to which the rate override belongs. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person to which the rate override belongs. -
PersonName: string
Title:
Person Name
Name of the person to which the rate override belongs. -
PersonNumber: string
Title:
Person Number
Number of the person to which the rate override belongs. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project to which the rate override belongs. -
ProjectName: string
Title:
Project Name
Name of the project to which the rate override belongs. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the rate override belongs. -
Rate: number
Title:
Rate
The rate assigned to the rate override. -
RateOverrideId: integer
(int64)
Title:
Rate Override ID
Read Only:true
The unique identifier of the rate override. -
RateOverrideReason: string
Title:
Rate Override Reason
The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type. -
RateOverrideReasonCode: string
Title:
Rate Override Reason Code
Maximum Length:30
The reason code for changing the rate override. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the rate override belongs. -
TaskName: string
Title:
Task Name
Name of the task to which the rate override belongs. -
TaskNumber: string
Title:
Task Number
Number of the task to which the rate override belongs. -
ToDate: string
(date)
Title:
To Date
Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.
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.
Examples
Example
The following example shows how to get all cost rate override details by submitting a GET request on the REST resource using cURL.
curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X GET -d @example_request_payload.json https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAndTaskCostRateOverrides/
Response Body
The following shows an example of the response body in JSON
format.
{ "items": [ { "RateOverrideId": 300100561359361, "ProjectId": 300100561359344, "ProjectNumber": "300100561359344", "ProjectName": "Resource Rates Override", "TaskId": null, "TaskNumber": null, "TaskName": null, "PersonId": 53, "PersonNumber": "53", "PersonEmail": "sendmail-test-discard@vision.com", "PersonName": "Smith, Devon", "JobId": null, "JobCode": null, "JobName": null, "ExpenditureTypeId": null, "ExpenditureTypeName": null, "Rate": 45, "CurrencyCode": "USD", "CurrencyName": "US Dollar", "FromDate": "2022-07-13", "ToDate": null, "RateOverrideReasonCode": null, "RateOverrideReason": null, "CreationDate": "2022-07-13T09:06:01.956+00:00", "CreatedBy": "carlton.baugh", "LastUpdateDate": "2022-07-13T09:07:24.497+00:00", "LastUpdatedBy": "carlton.baugh", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/300100561359361", "name": "projectandTaskCostRateOverrides", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/300100561359361", "name": "projectandTaskCostRateOverrides", "kind": "item" } ] } ] }