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

Get all rate schedules

get

/fscmRestApi/resources/11.13.18.05/rateSchedules

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the rate schedule with the specified rate schedule ID.
      Finder Variables
      • RateScheduleId; integer; Identifier of the rate schedule.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : rateSchedules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
  • Discriminator: ScheduleTypeCode
    Discriminator: { "propertyName":"ScheduleTypeCode", "mapping":{ "EMPLOYEE":"#/components/schemas/oracle_apps_projects_foundation_setup_rates_restModel_view_EmployeeRateSchedulesRestVO-item-response", "JOB":"#/components/schemas/oracle_apps_projects_foundation_setup_rates_restModel_view_JobRateSchedulesRestVO-item-response", "NON-LABOR":"#/components/schemas/oracle_apps_projects_foundation_setup_rates_restModel_view_NonLaborRateSchedulesRestVO-item-response", "PROJECT_ROLE":"#/components/schemas/oracle_apps_projects_foundation_setup_rates_restModel_view_ProjectRoleRateSchedulesRestVO-item-response", "RESOURCE_CLASS":"#/components/schemas/oracle_apps_projects_foundation_setup_rates_restModel_view_ResourceClassRateSchedulesRestVO-item-response" } }
Nested Schema : Discriminator: ScheduleTypeCode
Type: object
Discriminator: ScheduleTypeCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_projects_foundation_setup_rates_restModel_view_EmployeeRateSchedulesRestVO-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated.
  • Title: Currency Name
    Maximum Length: 80
    Currency name associated with the rate schedule.
  • Title: Description
    Maximum Length: 250
    The description of the rate schedule.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Read Only: true
    The unique identifier of the rate schedule.
  • Title: Name
    Maximum Length: 30
    Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule.
  • Maximum Length: 30
    Default Value: EMPLOYEE
    Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated.
  • Maximum Length: 80
    Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated.
Nested Schema : oracle_apps_projects_foundation_setup_rates_restModel_view_JobRateSchedulesRestVO-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated.
  • Title: Currency Name
    Maximum Length: 80
    Currency name associated with the rate schedule.
  • Title: Description
    Maximum Length: 250
    The description of the rate schedule.
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the jobs associated with a job rate schedule type. A job set ID or Code is required to create a rate schedule with a job schedule type. The value can't be updated.
  • Identifier of the reference data set for the jobs associated with a job rate schedule type. A job set ID or Code is required to create a rate schedule with a job schedule type. The value can't be updated.
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the jobs associated with a job rate schedule type. A job set is required to create a rate schedule with a job schedule type. The value can't be updated.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Read Only: true
    The unique identifier of the rate schedule.
  • Title: Name
    Maximum Length: 30
    Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule.
  • Maximum Length: 30
    Default Value: JOB
    Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated.
  • Maximum Length: 80
    Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated.
Nested Schema : oracle_apps_projects_foundation_setup_rates_restModel_view_NonLaborRateSchedulesRestVO-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated.
  • Title: Currency Name
    Maximum Length: 80
    Currency name associated with the rate schedule.
  • Title: Description
    Maximum Length: 250
    The description of the rate schedule.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Read Only: true
    The unique identifier of the rate schedule.
  • Title: Name
    Maximum Length: 30
    Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule.
  • Maximum Length: 30
    Default Value: NON-LABOR
    Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated.
  • Maximum Length: 80
    Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated.
Nested Schema : oracle_apps_projects_foundation_setup_rates_restModel_view_ProjectRoleRateSchedulesRestVO-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated.
  • Title: Currency Name
    Maximum Length: 80
    Currency name associated with the rate schedule.
  • Title: Description
    Maximum Length: 250
    The description of the rate schedule.
  • Title: To Date
    Date after which the rate schedule line is no longer effective.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Title: Project Role ID
    Identifier of the project role for which a rate is defined in the rate schedule. A Project Role ID or Project Role Name is required to create a project role rate.
  • Title: Project Role
    Maximum Length: 240
    Name of the project role for which a rate is defined in the rate schedule. A Project Role Name or Project Role ID is required to create a project role rate.
  • Title: Rate
    The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.
  • Read Only: true
    Unique identifier of the rate.
  • RateScheduleDFF
  • Read Only: true
    The unique identifier of the rate schedule.
  • Title: Name
    Maximum Length: 30
    Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule.
  • Maximum Length: 30
    Default Value: PROJECT_ROLE
    Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated.
  • Maximum Length: 80
    Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated.
  • Title: From Date
    Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.
  • Read Only: true
    Maximum Length: 30
    Unit of measure code associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Unit of measure associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
Nested Schema : oracle_apps_projects_foundation_setup_rates_restModel_view_ResourceClassRateSchedulesRestVO-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Currency
    Maximum Length: 15
    Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated.
  • Title: Currency Name
    Maximum Length: 80
    Currency name associated with the rate schedule.
  • Title: Description
    Maximum Length: 250
    The description of the rate schedule.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Set Code
    Maximum Length: 30
    Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated
  • Title: Set Name
    Read Only: true
    Maximum Length: 80
    Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated.
  • Read Only: true
    The unique identifier of the rate schedule.
  • Title: Name
    Maximum Length: 30
    Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule.
  • Maximum Length: 30
    Default Value: RESOURCE_CLASS
    Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated.
  • Maximum Length: 80
    Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated.
Nested Schema : RateScheduleDFF
Type: array
Show Source
Nested Schema : rateSchedules-RateScheduleDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all rate schedules by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization:port/projectsFinancialsApi/resources/11.13.18.05/rateSchedules

Response Body Example

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "RateScheduleId": 300100010654734,
            "RateScheduleName": "CFQ233743",
            "Description": "Definition of rate schedule",
            "ProjectRatesSetId": 0,
            "ProjectRatesSetCode": "COMMON",
            "ProjectRatesSetName": "Common Set",
            "ScheduleTypeCode": "EMPLOYEE",
            "ScheduleTypeName": "Person",
            "CurrencyCode": "USD",
            "CurrencyName": "US Dollar",
            "CreationDate": "2012-05-29T23:39:26.427+00:00",
            "CreatedBy": "Connor.Horton",
            "LastUpdateDate": "2012-05-29T23:41:23.372+00:00",
            "LastUpdatedBy": "Connor.Horton",
            "links": [
                {
                    "rel": "self",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100010654734",
                    "name": "rateSchedules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100010654734",
                    "name": "rateSchedules",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100010654734/child/RateScheduleDFF",
                    "name": "RateScheduleDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/300100010654734/child/Rates",
                    "name": "Rates",
                    "kind": "collection"
                }
            ]
        },
        {
            "RateScheduleId": 100000012047313,
            "RateScheduleName": "Cable Labor Burden Markup",
            "Description": "Job bill rate schedule for labor with the markup equivalent to the burden multiplier",
            "ProjectRatesSetId": 0,
            "ProjectRatesSetCode": "COMMON",
            "ProjectRatesSetName": "Common Set",
            "ScheduleTypeCode": "EMPLOYEE",
            "ScheduleTypeName": "Person",
            "CurrencyCode": "USD",
            "CurrencyName": "US Dollar",
            "CreationDate": "2009-08-20T14:38:45.315+00:00",
            "CreatedBy": "OPERATIONS",
            "LastUpdateDate": "2009-08-20T14:52:56.401+00:00",
            "LastUpdatedBy": "OPERATIONS",
            "links": [
                {
                    "rel": "self",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/100000012047313",
                    "name": "rateSchedules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/100000012047313",
                    "name": "rateSchedules",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/100000012047313/child/RateScheduleDFF",
                    "name": "RateScheduleDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules/100000012047313/child/Rates",
                    "name": "Rates",
                    "kind": "collection"
                }
            ]
        }
		...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/rateSchedules",
            "name": "rateSchedules",
            "kind": "collection"
        }
    ]
}
Back to Top