Jump to

• Request
• Response
• Examples

Update an provider rate

patch

/fscmRestApi/resources/11.13.18.05/assetWarrantyProviderRates/{WarrantyProviderRateId}

Request

Path Parameters

• WarrantyProviderRateId(required): integer(int64)
  Value that uniquely identifies the warranty provider rate. The application creates this value when it creates the provider rate.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndDate: string (date-time)
  Title: Active to Date

  End Date of the warranty provider rate. This attribute is optional.
• LaborCurrencyCode: string
  Title: Labor Currency Code

  Maximum Length: 15

  Abbreviation that uniquely identifies the currency of the labor rate. This attribute is required.
• LaborRate: number
  Title: Hourly Rate

  Value that identifies the warranty provider's labor rate per hour. This attribute is required.
• MustSubmitClaimByDays: number
  Title: Submission Due In

  Value that identifies the number of days in which a claim must be submited based on the claim date This attribute is optional.
• StartDate: string (date-time)
  Title: Active from Date

  Start Date of the warranty provider rate. This attribute is required.
• WarrantyProviderId: integer (int64)
  Title: Warranty Provider ID

  Value that uniquely identifies the warranty provider. Either a provider Id or Number is required.
• WarrantyProviderNumber: string
  Title: Warranty Provider Number

  Maximum Length: 255

  Unique supplier number of a warranty provider. Either a provider Id or Number is required.
• WarrantyProviderRateId: integer (int64)
  Value that uniquely identifies the warranty provider rate. The application creates this value when it creates the provider rate.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Active from Date",
            "type":"string",
            "description":"Start Date of the warranty provider rate. This attribute is required.",
            "format":"date-time",
            "nullable":true
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider.  Either a provider Id or Number is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LaborRate":{
            "title":"Hourly Rate",
            "type":"number",
            "description":"Value that identifies the warranty provider's labor rate per hour.  This attribute is required.",
            "nullable":false
        },
        "MustSubmitClaimByDays":{
            "title":"Submission Due In",
            "type":"number",
            "description":"Value that identifies the number of days in which a claim must be submited based on the claim date  This attribute is optional.",
            "nullable":true
        },
        "WarrantyProviderRateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider rate. The application creates this value when it creates the provider rate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LaborCurrencyCode":{
            "title":"Labor Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency of the labor rate.   This attribute is required.",
            "nullable":false
        },
        "EndDate":{
            "title":"Active to Date",
            "type":"string",
            "description":"End Date of the warranty provider rate. This attribute is optional.",
            "format":"date-time",
            "nullable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":255,
            "type":"string",
            "description":"Unique supplier number of a warranty provider. Either a provider Id or Number is required.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VendorId",
                    "VendorNumber"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : assetWarrantyProviderRates-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Column that specifies the creator of the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Column that specifies the creation date of the row.
• EndDate: string (date-time)
  Title: Active to Date

  End Date of the warranty provider rate. This attribute is optional.
• LaborCurrency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Name of the currency for the cost transaction quantity. This value is read-only.
• LaborCurrencyCode: string
  Title: Labor Currency Code

  Maximum Length: 15

  Abbreviation that uniquely identifies the currency of the labor rate. This attribute is required.
• LaborRate: number
  Title: Hourly Rate

  Value that identifies the warranty provider's labor rate per hour. This attribute is required.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Column that identifies the date and time of the last update on the row.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Column that identifies the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MustSubmitClaimByDays: number
  Title: Submission Due In

  Value that identifies the number of days in which a claim must be submited based on the claim date This attribute is optional.
• StartDate: string (date-time)
  Title: Active from Date

  Start Date of the warranty provider rate. This attribute is required.
• WarrantyProviderId: integer (int64)
  Title: Warranty Provider ID

  Value that uniquely identifies the warranty provider. Either a provider Id or Number is required.
• WarrantyProviderName: string
  Title: Warranty Provider Name

  Read Only: true

  Maximum Length: 360

  Name of the warranty provider. This value is ready only.
• WarrantyProviderNumber: string
  Title: Warranty Provider Number

  Maximum Length: 255

  Unique supplier number of a warranty provider. Either a provider Id or Number is required.
• WarrantyProviderRateId: integer (int64)
  Value that uniquely identifies the warranty provider rate. The application creates this value when it creates the provider rate.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that specifies the creation date of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Column that specifies the creator of the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the warranty provider. This value is ready only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LaborRate":{
            "title":"Hourly Rate",
            "type":"number",
            "description":"Value that identifies the warranty provider's labor rate per hour.  This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "LaborCurrencyCode":{
            "title":"Labor Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency of the labor rate.   This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Active to Date",
            "type":"string",
            "description":"End Date of the warranty provider rate. This attribute is optional.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":255,
            "type":"string",
            "description":"Unique supplier number of a warranty provider. Either a provider Id or Number is required.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VendorId",
                    "VendorNumber"
                ]
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Active from Date",
            "type":"string",
            "description":"Start Date of the warranty provider rate. This attribute is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LaborCurrency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the currency for the cost transaction quantity. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider.  Either a provider Id or Number is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MustSubmitClaimByDays":{
            "title":"Submission Due In",
            "type":"number",
            "description":"Value that identifies the number of days in which a claim must be submited based on the claim date  This attribute is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderRateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider rate. The application creates this value when it creates the provider rate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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

This example describes how to update a warranty labor rate.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/assetWarrantyProviderRates/WarrantyProviderRateId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"LaborRate": "72.33",
"MustSubmitClaimByDays": 180,
"EndDate": "2025-02-28"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "WarrantyProviderRateId": 300100582287471,
    "WarrantyProviderId": 999992000322153,
    "WarrantyProviderNumber": "7141",
    "WarrantyProviderName": "Computer Service and Rentals",
    "LaborRate": 72.33,
    "LaborCurrencyCode": "USD",
    "LaborCurrency": "US Dollar",
    "MustSubmitClaimByDays": 180,
    "StartDate": "2023-03-01T00:00:00+00:00",
    "EndDate": "2025-02-28T00:00:00+00:00",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2023-04-04T14:57:12+00:00",
    "LastUpdatedBy": "MNT_QA",
    "LastUpdateDate": "2023-04-04T14:57:12.001+00:00"
}

Back to Top