Jump to

• Request
• Response
• Examples

Create a Cost Rate Override

post

/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code associated with the rate override.
• CurrencyName: string
  Title: Currency Name

  Maximum Length: 255

  Currency name associated with the rate override.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Identifier of the expenditure type to which the rate override belongs.
• ExpenditureTypeName: string
  Title: Expenditure Type Name

  Name of the expenditure type to which the rate override belongs.
• FromDate: string (date)
  Title: From Date

  Date from which the rate override is effective. The date format is YYYY-MM-DD.
• JobCode: string
  Title: Job Code

  Maximum Length: 255

  Code of the job to which the rate override belongs.
• JobId: integer (int64)
  Title: Job ID

  Identifier of the job to which the rate override belongs.
• JobName: string
  Title: Job Name

  Name of the job to which the rate override belongs.
• PersonEmail: string
  Title: Person Email

  Maximum Length: 255

  Email of the person to which the rate override belongs.
• PersonId: integer (int64)
  Title: Person ID

  Identifier of the person to which the rate override belongs.
• PersonName: string
  Title: Person Name

  Name of the person to which the rate override belongs.
• PersonNumber: string
  Title: Person Number

  Number of the person to which the rate override belongs.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project to which the rate override belongs.
• ProjectName: string
  Title: Project Name

  Name of the project to which the rate override belongs.
• ProjectNumber: string
  Title: Project Number

  Number of the project to which the rate override belongs.
• Rate: number
  Title: Rate

  The rate assigned to the rate override.
• RateOverrideReason: string
  Title: Rate Override Reason

  The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type.
• RateOverrideReasonCode: string
  Title: Rate Override Reason Code

  Maximum Length: 30

  The reason code for changing the rate override.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the rate override belongs.
• TaskName: string
  Title: Task Name

  Name of the task to which the rate override belongs.
• TaskNumber: string
  Title: Task Number

  Number of the task to which the rate override belongs.
• ToDate: string (date)
  Title: To Date

  Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"Number of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonName":{
            "title":"Person Name",
            "type":"string",
            "description":"Name of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "ProjectId"
                ]
            }
        },
        "ProjectName":{
            "title":"Project Name",
            "type":"string",
            "description":"Name of the project to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectNumber":{
            "title":"Project Number",
            "type":"string",
            "description":"Number of the project to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The rate assigned to the rate override.",
            "nullable":false
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "TaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"Number of the task to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobName":{
            "title":"Job Name",
            "type":"string",
            "description":"Name of the job to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":"255",
            "type":"string",
            "description":"Currency name associated with the rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Identifier of the expenditure type to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            }
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type Name",
            "type":"string",
            "description":"Name of the expenditure type to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code associated with the rate override.",
            "nullable":false
        },
        "RateOverrideReason":{
            "title":"Rate Override Reason",
            "type":"string",
            "description":"The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Identifier of the person to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "TaskName":{
            "title":"Task Name",
            "type":"string",
            "description":"Name of the task to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateOverrideReasonCode":{
            "title":"Rate Override Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"The reason code for changing the rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":"255",
            "type":"string",
            "description":"Code of the job to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the rate override is effective. The date format is YYYY-MM-DD.",
            "format":"date",
            "nullable":false
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.",
            "format":"date",
            "nullable":true
        },
        "PersonEmail":{
            "title":"Person Email",
            "maxLength":"255",
            "type":"string",
            "description":"Email of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Identifier of the job to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : projectandTaskCostRateOverrides-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code associated with the rate override.
• CurrencyName: string
  Title: Currency Name

  Maximum Length: 255

  Currency name associated with the rate override.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Identifier of the expenditure type to which the rate override belongs.
• ExpenditureTypeName: string
  Title: Expenditure Type Name

  Name of the expenditure type to which the rate override belongs.
• FromDate: string (date)
  Title: From Date

  Date from which the rate override is effective. The date format is YYYY-MM-DD.
• JobCode: string
  Title: Job Code

  Maximum Length: 255

  Code of the job to which the rate override belongs.
• JobId: integer (int64)
  Title: Job ID

  Identifier of the job to which the rate override belongs.
• JobName: string
  Title: Job Name

  Name of the job to which the rate override belongs.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Update By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonEmail: string
  Title: Person Email

  Maximum Length: 255

  Email of the person to which the rate override belongs.
• PersonId: integer (int64)
  Title: Person ID

  Identifier of the person to which the rate override belongs.
• PersonName: string
  Title: Person Name

  Name of the person to which the rate override belongs.
• PersonNumber: string
  Title: Person Number

  Number of the person to which the rate override belongs.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project to which the rate override belongs.
• ProjectName: string
  Title: Project Name

  Name of the project to which the rate override belongs.
• ProjectNumber: string
  Title: Project Number

  Number of the project to which the rate override belongs.
• Rate: number
  Title: Rate

  The rate assigned to the rate override.
• RateOverrideId: integer (int64)
  Title: Rate Override ID

  Read Only: true

  The unique identifier of the rate override.
• RateOverrideReason: string
  Title: Rate Override Reason

  The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type.
• RateOverrideReasonCode: string
  Title: Rate Override Reason Code

  Maximum Length: 30

  The reason code for changing the rate override.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the rate override belongs.
• TaskName: string
  Title: Task Name

  Name of the task to which the rate override belongs.
• TaskNumber: string
  Title: Task Number

  Number of the task to which the rate override belongs.
• ToDate: string (date)
  Title: To Date

  Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "type":"string",
            "description":"Name of the project to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "type":"string",
            "description":"Name of the job to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code associated with the rate override.",
            "nullable":false,
            "x-queryable":true
        },
        "RateOverrideReason":{
            "title":"Rate Override Reason",
            "type":"string",
            "description":"The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":"255",
            "type":"string",
            "description":"Code of the job to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateOverrideId":{
            "title":"Rate Override ID",
            "type":"integer",
            "description":"The unique identifier of the rate override.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Identifier of the job to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Update By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"Number of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "type":"string",
            "description":"Name of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "type":"string",
            "description":"Number of the project to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The rate assigned to the rate override.",
            "nullable":false,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"Number of the task to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":"255",
            "type":"string",
            "description":"Currency name associated with the rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Identifier of the expenditure type to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type Name",
            "type":"string",
            "description":"Name of the expenditure type to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Identifier of the person to which the rate override belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "type":"string",
            "description":"Name of the task to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateOverrideReasonCode":{
            "title":"Rate Override Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"The reason code for changing the rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the rate override is effective. The date format is YYYY-MM-DD.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date after which the rate override is no longer effective. The date format is YYYY-MM-DD.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonEmail":{
            "title":"Person Email",
            "maxLength":"255",
            "type":"string",
            "description":"Email of the person to which the rate override belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

The following example shows how to create a cost rate override by submitting a POST request on the REST resource using cURL.

curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X POST -d @example_request_payload.json
https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAndTaskCostRateOverrides/

Request Body Example

The following shows an example of the request body in JSON format.

{
    "ProjectName":"Vision-Financials Implementation",
    "TaskNumber":"2.1",
    "PersonId":"1561",
    "ExpenditureTypeId":"10000",
    "Rate":60,
    "CurrencyCode":"USD",
    "FromDate":"2024-01-10",
    "ToDate":"2024-04-23",
    "RateOverrideReasonCode":"TRAINING"
}

Response Body Example

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

{
    "RateOverrideId": 300100587541617,
    "ProjectId": 2255,
    "ProjectNumber": null,
    "ProjectName": "Vision-Financials Implementation",
    "TaskId": 3044,
    "TaskNumber": "2.1",
    "TaskName": null,
    "PersonId": 1561,
    "PersonNumber": null,
    "PersonEmail": null,
    "PersonName": null,
    "JobId": null,
    "JobCode": null,
    "JobName": null,
    "ExpenditureTypeId": 10000,
    "ExpenditureTypeName": null,
    "Rate": 60,
    "CurrencyCode": "USD",
    "CurrencyName": null,
    "FromDate": "2024-01-10",
    "ToDate": "2024-04-23",
    "RateOverrideReasonCode": "TRAINING",
    "RateOverrideReason": null,
    "CreationDate": "2024-03-07T06:03:49+00:00",
    "CreatedBy": "Charles.Smith",
    "LastUpdateDate": "2024-03-07T06:03:49.321+00:00",
    "LastUpdatedBy": "Charles.Smith",
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/300100587541617",
            "name": "projectandTaskCostRateOverrides",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/300100587541617",
            "name": "projectandTaskCostRateOverrides",
            "kind": "item"
        }
    ]
}

Back to Top