Update one location
patch
/fscmRestApi/resources/11.13.18.05/requisitionOneTimeLocations/{requisitionOneTimeLocationsUniqID}
Request
Path Parameters
-
requisitionOneTimeLocationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Requisition One-Time Locations resource and used to uniquely identify an instance of Requisition One-Time Locations. The client should not generate the hash key value. Instead, the client should query on the Requisition One-Time Locations collection resource in order to navigate to a specific instance of Requisition One-Time Locations to get the hash key.
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
Root Schema : schema
Type:
Show Source
object-
AddrElementAttribute1: string
Title:
Additional Address Element 1Maximum Length:150First additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Second additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Third additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Fourth additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Fifth additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1Maximum Length:240First line for the address. -
Address2: string
Title:
Address Line 2Maximum Length:240Second line for the address. -
Address3: string
Title:
Address Line 3Maximum Length:240Third line for the address. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines PhoneticMaximum Length:560Phonetic representation of the address. -
Building: string
Title:
BuildingMaximum Length:240Specific building name or number at the given address. -
City: string
Title:
CityMaximum Length:60Name of the city mentioned in the address. -
Country: string
Title:
Territory NameMaximum Length:80Country mentioned in the address. -
CountryCode: string
Title:
CountryMaximum Length:2County code mentioned in the address. -
County: string
Title:
CountyMaximum Length:60County mentioned in the address. -
FloorNumber: string
Title:
FloorMaximum Length:40Number that identifies the specific floor at a given address or in a particular building when building number is provided. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code ExtensionMaximum Length:20Four digit extension to the United States postal ZIP code. -
Province: string
Title:
ProvinceMaximum Length:60Province mentioned in the address. -
State: string
Title:
StateMaximum Length:60State mentioned in the address.
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.
Root Schema : requisitionOneTimeLocations-item-response
Type:
Show Source
object-
AddrElementAttribute1: string
Title:
Additional Address Element 1Maximum Length:150First additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Second additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Third additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Fourth additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Fifth additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1Maximum Length:240First line for the address. -
Address2: string
Title:
Address Line 2Maximum Length:240Second line for the address. -
Address3: string
Title:
Address Line 3Maximum Length:240Third line for the address. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines PhoneticMaximum Length:560Phonetic representation of the address. -
Building: string
Title:
BuildingMaximum Length:240Specific building name or number at the given address. -
City: string
Title:
CityMaximum Length:60Name of the city mentioned in the address. -
Country: string
Title:
Territory NameMaximum Length:80Country mentioned in the address. -
CountryCode: string
Title:
CountryMaximum Length:2County code mentioned in the address. -
County: string
Title:
CountyMaximum Length:60County mentioned in the address. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the address. -
CreationDate: string
(date-time)
Read Only:
trueDate on which the user created the address. -
FloorNumber: string
Title:
FloorMaximum Length:40Number that identifies the specific floor at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
AddressRead Only:trueFormatted address in a single line. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate on which user updated the address. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the address. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location IDRead Only:trueValue that uniquely identifies the location. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code ExtensionMaximum Length:20Four digit extension to the United States postal ZIP code. -
Province: string
Title:
ProvinceMaximum Length:60Province mentioned in the address. -
State: string
Title:
StateMaximum Length:60State mentioned in the address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update a location.
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/requisitionOneTimeLocations/requisitionOneTimeLocationsUniqID"
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.
{
"AddrElementAttribute2": "VerifyAddrElementAttribute2_Updated1",
"AddrElementAttribute3": "VerifyAddrElementAttribute3_Updated"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"AddrElementAttribute1": null,
"AddrElementAttribute2": "VerifyAddrElementAttribute2_Updated1",
"AddrElementAttribute3": "VerifyAddrElementAttribute3_Updated",
"AddrElementAttribute4": null,
"AddrElementAttribute5": null,
"Address1": "UNION",
"Address2": "PANTITLAN",
"Address3": null,
"Address4": null,
"LocationId": 300100541617801,
"AddressLinesPhonetic": null,
"Building": null,
"City": "MEXICO",
"CountryCode": "MX",
"County": null,
"FloorNumber": null,
"PostalCode": "08100",
"PostalPlus4Code": null,
"Province": null,
"State": "CDMEX",
"FormattedAddress": "PRIVADA UNION,AGRICOLA PANTITLAN,VerifyAddrElementAttribute3_Updated, VerifyAddrElementAttribute2_Updated1,08100 CIUDAD DE MEXICO, CDMEX,MEXICO",
"Country": "Mexico",
"CreatedBy": "CVRQST09",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/requisitionOneTimeLocations/300100541617801",
"name": "requisitionOneTimeLocations",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/requisitionOneTimeLocations/300100541617801",
"name": "requisitionOneTimeLocations",
"kind": "item"
}
]
}