Get all resource rates
get
/fscmRestApi/resources/11.13.18.05/resourceRates
Request
Query Parameters
-
effectiveDate: string
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
-
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 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.
- PrimaryKey Finds resource rates according to the specified attribute.
-
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:- 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.
- PeriodStatusCode; string; Period Status Code
- PeriodStatusMeaning; string; Period Status
- 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.
-
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
-
Effective-Of: string
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. -
Metadata-Context: string
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: string
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 : resourceRates
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : resourceRates-item-response
Type:
Show Source
object-
AttachmentEntityName: string
Default Value:
CST_STD_RESOURCE_RATESIdentifies the entity name of attachment to the resource rates. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CostBookCode: string
Title:
Cost BookMaximum Length:30Identifies a unique code given for a particular cost book, usually named to indicate the purpose of that cost book. -
CostBookId: integer
(int64)
Title:
Cost BookIndicates the cost book to which the resource rates are published from cost planning. -
CostOrgCode: string
Read Only:
trueMaximum Length:150Indicates the cost organization to which the resource rates are published from cost planning. -
CostOrgId: integer
(int64)
Title:
Cost OrganizationIndicates the cost organization to which the resource rates are published from cost planning. -
CostOrgName: string
Title:
Cost OrganizationMaximum Length:240Indicates the name of the organization classified as the cost organization. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time of the creation of the row. -
CreationSource: string
Maximum Length:
11Default Value:RESTIndicates the source which created the record. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Indicates the currency code in which the resource rate is maintained. -
EffectiveEndDate: string
(date)
Title:
Effective End DateIndicates the date at the end of the date range within which the row is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateIndicates the date at the beginning of the date range within which the row is effective -
ExtendedPrecision: integer
(int32)
Title:
Extended PrecisionRead Only:trueDefault Value:5Value that identifies the extended precision number after the decimal point for the specified currency code. -
FromPeriodName: string
Title:
Effective Start PeriodMaximum Length:15Indicates the period from which the resource rate is effective for periodic average books. -
InvOrgCode: string
Read Only:
trueMaximum Length:18Identifies the master organization for which the resource rate is entered. -
InvOrgId: integer
(int64)
Title:
PlantIdentifies the master organization for which the resource rate is entered. -
InvOrgName: string
Title:
PlantMaximum Length:240Indicates the name for the organization unit. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who last updated the row. -
LastUpdateSource: string
Maximum Length:
11Default Value:RESTIndicates the session login associated with the user who last updated the row. -
LastUsedDate: string
(date-time)
Title:
Last Used DateIndicates the date and time of the last update of the row. -
LastUsedTransactionId: integer
(int64)
Indicates the last resource transaction which used this resource rate for accounting.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PeriodicAverageFlagMeaning: string
Title:
Periodic Average CostRead Only:trueMaximum Length:80Value that indicates if the cost book is a periodic average cost book. -
PeriodStatusCode: string
Read Only:
trueMaximum Length:30Period Status Code -
PeriodStatusMeaning: string
Title:
MeaningRead Only:trueMaximum Length:80Period Status -
Precision: integer
(int32)
Title:
PrecisionRead Only:trueDefault Value:2Value that identifies the precision number after the decimal point for the specified currency code. -
PreviousEffectiveEndDate: string
(date-time)
Title:
Effective End DateIndicates the end date of the previously effective resource rate. -
PreviousEffectiveStartDate: string
(date-time)
Indicates the start date of the previously effective resource rate.
-
PreviousStandardResourceRateId: integer
(int64)
Indicates the resource rate that this resource rate record is replacing.
-
ProcessedFlagMeaning: string
Title:
Cost Processing StatusRead Only:trueMaximum Length:80Indicates 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
Title:
CodeRead Only:trueMaximum Length:30Unique code of the resource. -
ResourceId: integer
(int64)
Title:
ResourceIndicates the resource for which the rates are published. -
ResourceName: string
Title:
ResourceMaximum Length:80Name of the resource. -
resourceRateDetails: array
Resource Rate Details
Title:
Resource Rate DetailsResource rate details provides the breakdown of the total resource rate. -
ResourceType: string
Title:
Resource TypeRead Only:trueMaximum Length:30Type of resource such as equipment or labor. -
ResourceTypeMeaning: string
Title:
Resource TypeRead Only:trueMaximum Length:80Identifies the meaning of the resource type of the resource rate. -
ScenarioEventId: integer
(int64)
Indicates the scenario event from which the resource rate was published from.
-
ScenarioId: integer
(int64)
Title:
ScenarioIndicates the scenario for which this resource rate is set up. -
ScenarioNumber: string
Title:
ScenarioMaximum Length:30User definable number to identify the cost planning scenario. -
ScenarioPublishHeaderId: integer
(int64)
Indicates the surrogate key reference of the scenario publish header.
-
ScenarioRollupHeaderId: integer
(int64)
Identifies the cost planning scenario rollup header based on which the resource rate was published.
-
StagedForStandardCostAdjustmentFlag: boolean
Maximum Length:
1Indicates whether this rate has been staged for WIP revaluation due to resource rate adjustment. -
StandardResourceRateId: integer
(int64)
Indicates the surrogate identifier for the resource rate.
-
StatusCode: string
Title:
StatusMaximum Length:30Default Value:IN_PROCESSIndicates the status of the resource rates where 1 represents Published and 2 represents In Process. -
StatusCodeMeaning: string
Title:
StatusRead Only:trueMaximum Length:80Indicates the status meaning of the resource rates where 1 represents Published and 2 represents In Process. -
ToPeriodName: string
Title:
Effective End PeriodMaximum Length:15Indicates the period till which the resource rate is effective for periodic average books. -
TotalRate: number
Title:
Total RateRead Only:trueIndicates the summarized rate details for this resource. -
UOM: string
Title:
UOMMaximum Length:30Indicates the unit of measure for the resource. -
UOMName: string
Title:
UOMRead Only:trueMaximum Length:25Indicates the unit of measure for the resource.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Resource Rate Details
Type:
arrayTitle:
Resource Rate DetailsResource rate details provides the breakdown of the total resource rate.
Show Source
Nested Schema : resourceRates-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : resourceRates-resourceRateDetails-item-response
Type:
Show Source
object-
CostElementCode: string
Title:
Cost ElementMaximum Length:30Identifies the cost element code of the resource rate detail. -
CostElementDescription: string
Read Only:
trueMaximum Length:240Identifies the cost element description of the resource rate detail. -
CostElementId: integer
(int64)
Title:
Cost ElementIdentifies the cost element of the resource rate detail. -
CostElementType: string
Title:
Cost Element TypeRead Only:trueMaximum Length:30Identifies the cost element type of the resource rate detail. -
CostElementTypeMeaning: string
Title:
Cost Element TypeRead Only:trueMaximum Length:80Identifies the cost element type of the resource rate detail. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time of the creation of the row. -
CreationSource: string
Maximum Length:
11Default Value:RESTIndicates the interface used to create the resource rate detail record. -
ExpensePoolCode: string
Title:
Expense PoolMaximum Length:30Identifies the expense pool code of the resource rate detail. -
ExpensePoolId: integer
(int64)
Title:
Expense PoolIdentifies the expense pool of the resource rate detail. -
ExpensePoolName: string
Title:
Expense PoolRead Only:trueMaximum Length:80Identifies the expense pool name of the resource rate detail. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Indicates the session login associated to the user who last updated the row. -
LastUpdateSource: string
Maximum Length:
11Default Value:RESTIndicates the interface used to most recently update the resource rate detail record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StandardResourceRateDetailId: integer
(int64)
Indicates the surrogate identifier for the resource rate detail.
-
StandardResourceRateId: integer
(int64)
Indicates the reference of the resource rate under which the details are published.
-
UnitRate: number
Title:
RateIndicates the unit rate for the cost component in resource rate currency.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source