Jump to

• Request
• Response

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: 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 Top

Response

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.

Body ()

Root Schema : resourceRates-item-response

Type: object

Show Source

• 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

  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.
• PeriodStatusCode: string
  Read Only: true

  Maximum Length: 30

  Period Status Code
• PeriodStatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Period Status
• 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

  Read Only: true

  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.

{
    "type":"object",
    "properties":{
        "AttachmentEntityName":{
            "type":"string",
            "description":"Identifies the entity name of attachment to the resource rates.",
            "nullable":true,
            "default":"CST_STD_RESOURCE_RATES",
            "x-queryable":true
        },
        "CostBookCode":{
            "title":"Cost Book",
            "maxLength":30,
            "type":"string",
            "description":"Identifies a unique code given for a particular cost book, usually named to indicate the purpose of that cost book.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book",
            "type":"integer",
            "description":"Indicates the cost book to which the resource rates are published from cost planning.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CostOrgId"
                ]
            },
            "x-queryable":true
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "description":"Indicates the cost organization to which the resource rates are published from cost planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrgId":{
            "title":"Cost Organization",
            "type":"integer",
            "description":"Indicates the cost organization to which the resource rates are published from cost planning.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "CostOrgName":{
            "title":"Cost Organization",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name of the organization classified as the cost organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationSource":{
            "maxLength":11,
            "type":"string",
            "description":"Indicates the source which created the record.",
            "nullable":true,
            "default":"REST",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the currency code in which the resource rate is maintained.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"Value that identifies the extended precision number after the decimal point for the specified currency code.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":5,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "FromPeriodName":{
            "title":"Effective Start Period",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the period from which the resource rate is effective for periodic average books.",
            "nullable":true,
            "x-queryable":true
        },
        "InvOrgCode":{
            "maxLength":18,
            "type":"string",
            "description":"Identifies the master organization for which the resource rate is entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Plant",
            "type":"integer",
            "description":"Identifies the master organization for which the resource rate is entered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CostOrgId",
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "InvOrgName":{
            "title":"Plant",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name for the organization unit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateSource":{
            "maxLength":11,
            "type":"string",
            "description":"Indicates the session login associated with the user who last updated the row.",
            "nullable":true,
            "default":"REST",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUsedDate":{
            "title":"Last Used Date",
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUsedTransactionId":{
            "type":"integer",
            "description":"Indicates the last resource transaction which used this resource rate for accounting.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Period Status Code",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Period Status",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodicAverageFlagMeaning":{
            "title":"Periodic Average Cost",
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates if the cost book is a periodic average cost book.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"Value that identifies the precision number after the decimal point for the specified currency code.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":2,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PreviousEffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Indicates the end date of the previously effective resource rate.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousEffectiveStartDate":{
            "type":"string",
            "description":"Indicates the start date of the previously effective resource rate.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousStandardResourceRateId":{
            "type":"integer",
            "description":"Indicates the resource rate that this resource rate record is replacing.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessedFlagMeaning":{
            "title":"Cost Processing Status",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource",
            "type":"integer",
            "description":"Indicates the resource for which the rates are published.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "InvOrgId",
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource",
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of resource such as equipment or labor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceTypeMeaning":{
            "title":"Resource Type",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the meaning of the resource type of the resource rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventId":{
            "type":"integer",
            "description":"Indicates the scenario event from which the resource rate was published from.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScenarioId":{
            "title":"Scenario",
            "type":"integer",
            "description":"Indicates the scenario for which this resource rate is set up.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "title":"Scenario",
            "maxLength":30,
            "type":"string",
            "description":"User definable number to identify the cost planning scenario.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioPublishHeaderId":{
            "type":"integer",
            "description":"Indicates the surrogate key reference of the scenario publish header.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScenarioRollupHeaderId":{
            "type":"integer",
            "description":"Identifies the cost planning scenario rollup header based on which the resource rate was published.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StagedForStandardCostAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this rate has been staged for WIP revaluation due to resource rate adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardResourceRateId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier for the resource rate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the resource rates where 1 represents Published and 2 represents In Process.",
            "nullable":true,
            "default":"IN_PROCESS",
            "x-queryable":true
        },
        "StatusCodeMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the status meaning of the resource rates where 1 represents Published and 2 represents In Process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ToPeriodName":{
            "title":"Effective End Period",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the period till which the resource rate is effective for periodic average books.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRate":{
            "title":"Total Rate",
            "type":"number",
            "description":"Indicates the summarized rate details for this resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure for the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Indicates the unit of measure for the resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/resourceRates-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "resourceRateDetails":{
            "title":"Resource Rate Details",
            "type":"array",
            "description":"Resource rate details provides the breakdown of the total resource rate.",
            "items":{
                "$ref":"#/components/schemas/resourceRates-resourceRateDetails-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object resourceRates-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/resourceRates-attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Resource Rate Details

Type: array

Title: Resource Rate Details

Resource rate details provides the breakdown of the total resource rate.

Show Source

• Array of: object resourceRates-resourceRateDetails-item-response

{
    "title":"Resource Rate Details",
    "type":"array",
    "description":"Resource rate details provides the breakdown of the total resource rate.",
    "items":{
        "$ref":"#/components/schemas/resourceRates-resourceRateDetails-item-response"
    }
}

Nested Schema : resourceRates-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared
• 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.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : resourceRates-resourceRateDetails-item-response

Type: object

Show Source

• 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

  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

  Read Only: true

  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.

{
    "type":"object",
    "properties":{
        "CostElementCode":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the cost element code of the resource rate detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the cost element description of the resource rate detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element",
            "type":"integer",
            "description":"Identifies the cost element of the resource rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CostElementType":{
            "title":"Cost Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the cost element type of the resource rate detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementTypeMeaning":{
            "title":"Cost Element Type",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the cost element type of the resource rate detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationSource":{
            "maxLength":11,
            "type":"string",
            "description":"Indicates the interface used to create the resource rate detail record.",
            "nullable":true,
            "default":"REST",
            "x-queryable":true
        },
        "ExpensePoolCode":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the expense pool code of the resource rate detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool",
            "type":"integer",
            "description":"Identifies the expense pool of the resource rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ExpensePoolName":{
            "title":"Expense Pool",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the expense pool name of the resource rate detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateSource":{
            "maxLength":11,
            "type":"string",
            "description":"Indicates the interface used to most recently update the resource rate detail record.",
            "nullable":true,
            "default":"REST",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardResourceRateDetailId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier for the resource rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StandardResourceRateId":{
            "type":"integer",
            "description":"Indicates the reference of the resource rate under which the details are published.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UnitRate":{
            "title":"Rate",
            "type":"number",
            "description":"Indicates the unit rate for the cost component in resource rate currency.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

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

PlantLovVA

Parameters:

• finder: FilterByCostOrgId%3BCostOrgId%3D{CostOrgId}%2CMfgPlantFlag%3DY

The following properties are defined on the LOV link relation:

• Source Attribute: InvOrgId; Target Attribute: InvOrgId
• Display Attribute: Invorgname

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/addCostElement

Parameters:

• 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.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/child/attachments

Parameters:

• resourceRatesUniqID: $request.path.resourceRatesUniqID

The attachments resource is used to view, create, and update attachments.

decreaseCost

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/decreaseCost

Parameters:

• 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.

deleteCostElement

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/deleteCostElement

Parameters:

• resourceRatesUniqID: $request.path.resourceRatesUniqID

Delete rate details for selected resource rates edited using the Perform Mass Edit capability in the Resource Rates page.

increaseCost

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/increaseCost

Parameters:

• 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.

replaceCost

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/replaceCost

Parameters:

• 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.

resourceRateDetails

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/child/resourceRateDetails

Parameters:

• resourceRatesUniqID: $request.path.resourceRatesUniqID

Resource rate details provides the breakdown of the total resource rate.

substituteCostElement

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/substituteCostElement

Parameters:

• 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.

substituteExpensePool

Operation: /fscmRestApi/resources/11.13.18.05/resourceRates/{resourceRatesUniqID}/action/substituteExpensePool

Parameters:

• 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.

Back to Top