Get one resource rate
get
/fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}
Request
Path Parameters
-
resourceRatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Resource Rates resource and used to uniquely identify an instance of Resource Rates. The client should not generate the hash key value. Instead, the client should query on the Resource Rates collection resource in order to navigate to a specific instance of Resource Rates 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
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:
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 : resourceRates-item-response
Type:
Show Source
object
-
AttachmentEntityName: string
Default Value:
CST_STD_RESOURCE_RATES
Identifies the entity name of attachment to the resource rates. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CostBookCode: string
Title:
Cost Book
Maximum Length:30
Identifies a unique code given for a particular cost book, usually named to indicate the purpose of that cost book. -
CostBookId: integer
(int64)
Title:
Cost Book
Indicates the cost book to which the resource rates are published from cost planning. -
CostOrgCode: string
Read Only:
true
Maximum Length:150
Indicates the cost organization to which the resource rates are published from cost planning. -
CostOrgId: integer
(int64)
Title:
Cost Organization
Indicates the cost organization to which the resource rates are published from cost planning. -
CostOrgName: string
Title:
Cost Organization
Read Only:true
Maximum Length:240
Indicates the name of the organization classified as the cost organization. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
CreationSource: string
Maximum Length:
11
Default Value:REST
Indicates the source which created the record. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Indicates the currency code in which the resource rate is maintained. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Indicates the date at the end of the date range within which the row is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Indicates the date at the beginning of the date range within which the row is effective -
ExtendedPrecision: integer
(int32)
Title:
Extended Precision
Read Only:true
Default Value:5
Value that identifies the extended precision number after the decimal point for the specified currency code. -
FromPeriodName: string
Title:
Effective Start Period
Maximum Length:15
Indicates the period from which the resource rate is effective for periodic average books. -
InvOrgCode: string
Read Only:
true
Maximum Length:18
Identifies the master organization for which the resource rate is entered. -
InvOrgId: integer
(int64)
Title:
Plant
Identifies the master organization for which the resource rate is entered. -
InvOrgName: string
Title:
Plant
Maximum Length:240
Indicates the name for the organization unit. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateSource: string
Maximum Length:
11
Default Value:REST
Indicates the session login associated with the user who last updated the row. -
LastUsedDate: string
(date-time)
Title:
Last Used Date
Indicates 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:
Links
The link relations associated with the resource instance. -
PeriodicAverageFlagMeaning: string
Title:
Periodic Average Cost
Read Only:true
Maximum Length:80
Value that indicates if the cost book is a periodic average cost book. -
Precision: integer
(int32)
Title:
Precision
Read Only:true
Default Value:2
Value that identifies the precision number after the decimal point for the specified currency code. -
PreviousEffectiveEndDate: string
(date-time)
Title:
Effective End Date
Indicates 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 Status
Read Only:true
Maximum Length:80
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
Title:
Code
Read Only:true
Maximum Length:30
Unique code of the resource. -
ResourceId: integer
(int64)
Title:
Resource
Indicates the resource for which the rates are published. -
ResourceName: string
Title:
Resource
Maximum Length:80
Name of the resource. -
resourceRateDetails: array
Resource Rate Details
Title:
Resource Rate Details
Resource rate details provides the breakdown of the total resource rate. -
ResourceType: string
Title:
Resource Type
Read Only:true
Maximum Length:30
Type of resource such as equipment or labor. -
ResourceTypeMeaning: string
Title:
Resource Type
Read Only:true
Maximum Length:80
Identifies 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:
Scenario
Indicates the scenario for which this resource rate is set up. -
ScenarioNumber: string
Title:
Scenario
Maximum Length:30
User 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:
1
Indicates 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:
Status
Maximum Length:30
Default Value:IN_PROCESS
Indicates the status of the resource rates where 1 represents Published and 2 represents In Process. -
StatusCodeMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Indicates the status meaning of the resource rates where 1 represents Published and 2 represents In Process. -
ToPeriodName: string
Title:
Effective End Period
Maximum Length:15
Indicates the period till which the resource rate is effective for periodic average books. -
TotalRate: number
Title:
Total Rate
Indicates the summarized rate details for this resource. -
UOM: string
Title:
UOM
Maximum Length:30
Indicates the unit of measure for the resource. -
UOMName: string
Title:
UOM
Read Only:true
Maximum Length:25
Indicates the unit of measure for the resource.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : resourceRates-resourceRateDetails-item-response
Type:
Show Source
object
-
CostElementCode: string
Title:
Cost Element
Maximum Length:30
Identifies the cost element code of the resource rate detail. -
CostElementDescription: string
Read Only:
true
Maximum Length:240
Identifies the cost element description of the resource rate detail. -
CostElementId: integer
(int64)
Title:
Cost Element
Identifies the cost element of the resource rate detail. -
CostElementType: string
Title:
Cost Element Type
Read Only:true
Maximum Length:30
Identifies the cost element type of the resource rate detail. -
CostElementTypeMeaning: string
Title:
Cost Element Type
Read Only:true
Maximum Length:80
Identifies the cost element type of the resource rate detail. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
CreationSource: string
Maximum Length:
11
Default Value:REST
Indicates the interface used to create the resource rate detail record. -
ExpensePoolCode: string
Title:
Expense Pool
Read Only:true
Maximum Length:30
Identifies the expense pool code of the resource rate detail. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool
Identifies the expense pool of the resource rate detail. -
ExpensePoolName: string
Title:
Expense Pool
Maximum Length:80
Identifies the expense pool name of the resource rate detail. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
LastUpdateSource: string
Maximum Length:
11
Default Value:REST
Indicates the interface used to most recently update the resource rate detail record. -
links: array
Links
Title:
Links
The 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:
Rate
Indicates the unit rate for the cost component in resource rate currency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CostBookLovVA
-
Parameters:
- finder:
FilterByScenarioAndCostOrg%3BCostOrgId%3D{CostOrgId}%2CScenarioId%3D{ScenarioId}
The following properties are defined on the LOV link relation:- Source Attribute: CostBookId; Target Attribute: CostBookId
- Display Attribute: CostBookCode
- finder:
- CostOrganizationLovVA
-
Parameters:
- finder:
FilterByScenarioId%3BScenarioId%3D{ScenarioId}
The following properties are defined on the LOV link relation:- Source Attribute: CostOrgId; Target Attribute: CostOrgId
- Display Attribute: CostOrganizationName
- finder:
- PlantLovVA
-
Parameters:
- finder:
FilterByCostOrgId%3BCostOrgId%3D{CostOrgId}
The following properties are defined on the LOV link relation:- Source Attribute: InvOrgId; Target Attribute: InvOrgId
- Display Attribute: Invorgname
- finder:
- ResourceLovVA
-
Parameters:
- finder:
FilterByOrgId%3BOrganizationId%3D{InvOrgId}
The following properties are defined on the LOV link relation:- Source Attribute: ResourceId; Target Attribute: ResourceId
- Display Attribute: ResourceName
- finder:
- ScenarioLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: ScenarioId; Target Attribute: ScenarioId
- Display Attribute: ScenarioNumber
- addCostElement
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/addCostElementParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Add a new cost element to the selected resource rates using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- attachments
-
Parameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
The attachments resource is used to view, create, and update attachments. - resourceRatesUniqID:
- decreaseCost
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/decreaseCostParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Decrease unit rate of cost elements for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- deleteCostElement
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/deleteCostElementParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Delete rate details for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- increaseCost
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/increaseCostParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Increase unit rate of cost elements for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- replaceCost
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/replaceCostParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Replace the unit rate of cost elements for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- resourceRateDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/child/resourceRateDetailsParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Resource rate details provides the breakdown of the total resource rate. - resourceRatesUniqID:
- substituteCostElement
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/substituteCostElementParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Substitute one specific cost element for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID:
- substituteExpensePool
-
Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/substituteExpensePoolParameters:
- resourceRatesUniqID:
$request.path.resourceRatesUniqID
Substitute one specific expense pool for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page. - resourceRatesUniqID: