Jump to

• Request
• Response
• Examples

Update

patch

/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilities/{CoverageApplicabilityId}

Request

Path Parameters

• CoverageApplicabilityId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CoverageId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AutoAssignFlag: boolean
  Title: Autoassign

  Maximum Length: 1

  Default Value: true
• ContractDefaultStatusCode: string
  Title: Contract Default Status Code

  Maximum Length: 30
• DisabledFlag: boolean
  Title: Disabled Indicator

  Maximum Length: 80
• ItemId: integer (int64)
  Title: Item ID
• ItemNumber: string
  Title: Item Number

  Maximum Length: 255
• ItemOrganizationCode: string
  Title: Item Organization Code

  Maximum Length: 255
• ItemOrganizationId: integer (int64)
  Title: Item Organization ID
• SupplierId: integer (int64)
  Title: Supplier ID
• SupplierNumber: string
  Title: Supplier Number

  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "AutoAssignFlag":{
            "title":"Autoassign",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ContractDefaultStatusCode":{
            "title":"Contract Default Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":80,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ItemOrganizationCode":{
            "title":"Item Organization Code",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":255,
            "type":"string",
            "nullable":true
        }
    }
}

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 : assetWarrantyCoverages-coverageApplicabilities-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: Active End Date

  Read Only: true
• AutoAssignFlag: boolean
  Title: Autoassign

  Maximum Length: 1

  Default Value: true
• ContractDefaultStatus: string
  Title: Contract Default Status

  Read Only: true

  Maximum Length: 80
• ContractDefaultStatusCode: string
  Title: Contract Default Status Code

  Maximum Length: 30
• CoverageApplicabilityId: integer (int64)
  Title: Coverage Applicability ID

  Read Only: true
• CoverageId: integer (int64)
  Title: Coverage ID

  Read Only: true
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• DisabledFlag: boolean
  Title: Disabled Indicator

  Maximum Length: 80
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240
• ItemId: integer (int64)
  Title: Item ID
• ItemLongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000
• ItemNumber: string
  Title: Item Number

  Maximum Length: 255
• ItemOrganizationCode: string
  Title: Item Organization Code

  Maximum Length: 255
• ItemOrganizationId: integer (int64)
  Title: Item Organization ID
• ItemOrganizationName: string
  Title: Item Organization Name

  Read Only: true

  Maximum Length: 255
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupplierId: integer (int64)
  Title: Supplier ID
• SupplierName: string
  Title: Supplier Name

  Read Only: true

  Maximum Length: 360
• SupplierNumber: string
  Title: Supplier Number

  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AutoAssignFlag":{
            "title":"Autoassign",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContractDefaultStatus":{
            "title":"Contract Default Status",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractDefaultStatusCode":{
            "title":"Contract Default Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageApplicabilityId":{
            "title":"Coverage Applicability ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":80,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ItemOrganizationCode":{
            "title":"Item Organization Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemOrganizationName":{
            "title":"Item Organization Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to update a coverage applicable item for a warranty coverage.

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/assetWarrantyCoverages/CoverageId/child/coverageApplicabilities/CoverageApplicabilityId"

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.

{
"ContractDefaultStatusCode": "ORA_READY"
}

Example Response Body

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

{
    "CoverageApplicabilityId": 300100568130763,
    "CoverageId": 300100568130739,
    "ItemId": 300100566813001,
    "ItemNumber": "ALM-MX-ITEM-001",
    "ItemDescription": "ALM-MX-ITEM-001-DESC",
    "ItemLongDescription": "ALM-MX-ITEM-001-DESC-LONG",
    "ItemOrganizationId": 300100113363336,
    "ItemOrganizationCode": "ORG1",
    "ItemOrganizationName": "Organization1",
    "SupplierId": 999992000322153,
    "SupplierNumber": "654321",
    "SupplierName": "Supplier1",
    "AutoAssignFlag": false,
    "ContractDefaultStatusCode": "ORA_READY",
    "ContractDefaultStatus": "Ready",
    "DisabledFlag": false,
    "ActiveEndDate": null,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T14:48:10+00:00",
    "LastUpdatedBy": "USER",
    "LastUpdateDate": "2022-10-28T14:48:10.001+00:00",
     "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763",
            "name": "coverageApplicabilities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763",
            "name": "coverageApplicabilities",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739",
            "name": "assetWarrantyCoverages",
            "kind": "item"
        }
    ]
}

Back to Top