Jump to

• Request
• Response
• Examples

Update one purchase order in-transit valuation-ownership change rules

patch

/fscmRestApi/resources/11.13.18.05/intransitValuationOwnershipChangeRules/{FOBLookupCode}

Request

Path Parameters

• FOBLookupCode(required): string
  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

• Message: string
  Maximum Length: 255

  Indicates the status and informational warnings for created and updated records.
• OwnershipChange: string
  Title: Ownership Change Event

  Maximum Length: 64

  Indicates the ownership-change event for each FOB lookup code. Possible values are ASN and Receipt.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the status and informational warnings for created and updated records.",
            "nullable":true
        },
        "OwnershipChange":{
            "title":"Ownership Change Event",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the ownership-change event for each FOB lookup code. Possible values are ASN and Receipt.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the purchase order in-transit valuation-ownership change rule.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date when the user created the purchase order in-transit valuation-ownership change rule.
• FOBLookupCode: string
  Title: FOB Code

  Maximum Length: 30

  Indicates the type of free-on-board terms for which an ownership-change document is defined.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates the date when the user most recently updated the purchase order in-transit valuation-ownership change rule.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who most recently updated the purchase order in-transit valuation-ownership change rule.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login when the user most recently updated the ASN in-transit ownership rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Indicates the status and informational warnings for created and updated records.
• OwnershipChange: string
  Title: Ownership Change Event

  Maximum Length: 64

  Indicates the ownership-change event for each FOB lookup code. Possible values are ASN and Receipt.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who most recently updated the purchase order in-transit valuation-ownership change rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date when the user created the purchase order in-transit valuation-ownership change rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the purchase order in-transit valuation-ownership change rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FOBLookupCode":{
            "title":"FOB Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of free-on-board terms for which an ownership-change document is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the status and informational warnings for created and updated records.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnershipChange":{
            "title":"Ownership Change Event",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the ownership-change event for each FOB lookup code. Possible values are ASN and Receipt.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date when the user most recently updated the purchase order in-transit valuation-ownership change rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login when the user most recently updated the ASN in-transit ownership rule.",
            "nullable":true,
            "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."
        }
    }
}

Links

FobLookupCodeLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DFOB

The following properties are defined on the LOV link relation:

• Source Attribute: FOBLookupCode; Target Attribute: LookupCode
• Display Attribute: Meaning

OwnershipChangeLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMR_OWNERSHIP_CHANGE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: OwnershipChange; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

This example describes how to update one purchase order in-transit valuation-ownership change rule.

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/intransitValuationOwnershipChangeRules/FOBLookupCode"

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.

{
    “OwnershipChange”: “ASN”
}

Example Response Body

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

{
  "FOBLookupCode" : "Destination",
  "OwnershipChange" : "ASN",
  "CreatedBy" : "COST_ACCT_ALL_COST_ORGS",
  "CreationDate" : "2024-08-14T07:49:08+00:00",
  "LastUpdateDate" : "2024-08-14T07:50:33+00:00",
  "LastUpdateLogin" : "1BD832220C34BD41E063383D060A2F89",
  "LastUpdatedBy" : "COST_ACCT_ALL_COST_ORGS",
  "Message" : "The ownership rule has been updated.",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/intransitValuationOwnershipChangeRules/Destination",
    "name" : "intransitValuationOwnershipChangeRules",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/intransitValuationOwnershipChangeRules/Destination",
    "name" : "intransitValuationOwnershipChangeRules",
    "kind" : "item"
  } ]
}

Back to Top