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 1
Maximum Length:150
First additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
Second additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
Third additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
Fourth additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
Fifth additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
First line for the address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
Second line for the address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
Third line for the address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
Fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
Phonetic representation of the address. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at the given address. -
City: string
Title:
City
Maximum Length:60
Name of the city mentioned in the address. -
Country: string
Title:
Territory Name
Maximum Length:80
Country mentioned in the address. -
CountryCode: string
Title:
Country
Maximum Length:2
County code mentioned in the address. -
County: string
Title:
County
Maximum Length:60
County mentioned in the address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
Number that identifies the specific floor at a given address or in a particular building when building number is provided. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
Four digit extension to the United States postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
Province mentioned in the address. -
State: string
Title:
State
Maximum Length:60
State 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 1
Maximum Length:150
First additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
Second additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
Third additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
Fourth additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
Fifth additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
First line for the address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
Second line for the address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
Third line for the address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
Fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
Phonetic representation of the address. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at the given address. -
City: string
Title:
City
Maximum Length:60
Name of the city mentioned in the address. -
Country: string
Title:
Territory Name
Maximum Length:80
Country mentioned in the address. -
CountryCode: string
Title:
Country
Maximum Length:2
County code mentioned in the address. -
County: string
Title:
County
Maximum Length:60
County mentioned in the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the address. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the user created the address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
Number that identifies the specific floor at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
Formatted address in a single line. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which user updated the address. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location ID
Read Only:true
Value that uniquely identifies the location. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
Four digit extension to the United States postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
Province mentioned in the address. -
State: string
Title:
State
Maximum Length:60
State mentioned in the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
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" } ] }