1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Rate Schedules
  4. Rates

Get all

get

/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates

Request

Path Parameters
  • 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=
Query Parameters
  • 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>
  • 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
  • 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; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • EndDateActive; string; Date after which the rate schedule line is no longer effective.
    • JobCode; string; Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
    • JobId; integer; Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.
    • JobName; string; Name of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • Rate; number; The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.
    • RateId; integer; Unique identifier of the rate.
    • StartDateActive; string; Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.
    • UnitOfMeasureCode; string; Unit of measure code associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
    • UnitOfMeasureName; string; Unit of measure associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
    • count; integer; The number of resource instances returned in the current range.
    • hasMore; 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.
    • limit; integer; The actual paging size used by the server.
    • offset; integer; The offset value used in the current page.
    • totalResults; integer; The estimated row count when "?totalResults=true", otherwise the count is not included.
  • 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 : rateSchedules-JobRates
Type: object
Show Source
  • The number of resource instances returned in the current range.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: To Date
    Date after which the rate schedule line is no longer effective.
  • 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.
  • Title: Code
    Maximum Length: 30
    Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
  • Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.
  • Title: Job
    Read Only: true
    Maximum Length: 240
    Name of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • The actual paging size used by the server.
  • Links
  • The offset value used in the current page.
  • Title: Rate
    The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.
  • Read Only: true
    Unique identifier of the rate.
  • Title: From Date
    Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.
  • The estimated row count when "?totalResults=true", otherwise the count is not included.
  • Read Only: true
    Maximum Length: 30
    Unit of measure code associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Unit of measure associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
Back to Top