Get all resource rates

get

/fscmRestApi/resources/11.13.18.05/resourceRates

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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 resource rates according to the specified attribute.
      Finder Variables
      • StandardResourceRateId; integer; Identifies the resource rate associated with the resource rate detail.
    • PublishedResourceRateByInvOrgAsOfDate Finds resource rates based on bind variables.
      Finder Variables
      • bindAsOfDate; string; Value that identifies the resource rate based on the effective date.
      • bindInvOrgName; string; Value that identifies resource rates based on the inventory organization 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:
    • AttachmentEntityName; string; Identifies the entity name of attachment to the resource rates.
    • CostBookCode; string; Identifies a unique code given for a particular cost book, usually named to indicate the purpose of that cost book.
    • CostBookId; integer; Indicates the cost book to which the resource rates are published from cost planning.
    • CostOrgCode; string; Indicates the cost organization to which the resource rates are published from cost planning.
    • CostOrgId; integer; Indicates the cost organization to which the resource rates are published from cost planning.
    • CostOrgName; string; Indicates the name of the organization classified as the cost organization.
    • CreationSource; string; Indicates the source which created the record.
    • CurrencyCode; string; Indicates the currency code in which the resource rate is maintained.
    • EffectiveEndDate; string; Indicates the date at the end of the date range within which the row is effective.
    • EffectiveStartDate; string; Indicates the date at the beginning of the date range within which the row is effective
    • ExtendedPrecision; integer; Value that identifies the extended precision number after the decimal point for the specified currency code.
    • FromPeriodName; string; Indicates the period from which the resource rate is effective for periodic average books.
    • InvOrgCode; string; Identifies the master organization for which the resource rate is entered.
    • InvOrgId; integer; Identifies the master organization for which the resource rate is entered.
    • InvOrgName; string; Indicates the name for the organization unit.
    • LastUpdateSource; string; Indicates the session login associated with the user who last updated the row.
    • LastUsedDate; string; Indicates the date and time of the last update of the row.
    • PeriodicAverageFlagMeaning; string; Value that indicates if the cost book is a periodic average cost book.
    • Precision; integer; Value that identifies the precision number after the decimal point for the specified currency code.
    • PreviousEffectiveEndDate; string; Indicates the end date of the previously effective resource rate.
    • PreviousEffectiveStartDate; string; Indicates the start date of the previously effective resource rate.
    • ProcessedFlagMeaning; string; Indicates if the resource rate is picked up by the cost processor. Possible values are: N - The resource rate isn't picked up by the cost processor, W - The resource rate is being processed, Y - The resource rate is processed.
    • ResourceCode; string; Unique code of the resource.
    • ResourceId; integer; Indicates the resource for which the rates are published.
    • ResourceName; string; Name of the resource.
    • ResourceType; string; Type of resource such as equipment or labor.
    • ResourceTypeMeaning; string; Identifies the meaning of the resource type of the resource rate.
    • ScenarioId; integer; Indicates the scenario for which this resource rate is set up.
    • ScenarioNumber; string; User definable number to identify the cost planning scenario.
    • StagedForStandardCostAdjustmentFlag; boolean; Indicates whether this rate has been staged for WIP revaluation due to resource rate adjustment.
    • StandardResourceRateId; integer; Indicates the surrogate identifier for the resource rate.
    • StatusCode; string; Indicates the status of the resource rates where 1 represents Published and 2 represents In Process.
    • StatusCodeMeaning; string; Indicates the status meaning of the resource rates where 1 represents Published and 2 represents In Process.
    • ToPeriodName; string; Indicates the period till which the resource rate is effective for periodic average books.
    • TotalRate; number; Indicates the summarized rate details for this resource.
    • UOM; string; Indicates the unit of measure for the resource.
    • UOMName; string; Indicates the unit of measure for the resource.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : resourceRates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : resourceRates-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Resource Rate Details
Type: array
Title: Resource Rate Details
Resource rate details provides the breakdown of the total resource rate.
Show Source
Nested Schema : resourceRates-attachments-item-response
Type: object
Show Source
Nested Schema : resourceRates-resourceRateDetails-item-response
Type: object
Show Source
Back to Top