Update a state
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStates/{publicSectorStatesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorStatesUniqID: integer
This is the hash key of the attributes which make up the composite key--- CountryCode and StateCodeISO ---for the States resource and used to uniquely identify an instance of States. The client should not generate the hash key value. Instead, the client should query on the States collection resource with a filter on the primary key values in order to navigate to a specific instance of States.
For example: publicSectorStates?q=CountryCode=<value1>;StateCodeISO=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorStates-item
Type:
Show Source
object
-
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the state. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the state. -
CreationDate(optional):
string(date-time)
The date and time that the state was created.
-
DeletedFlag(optional):
boolean
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the state was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the state. -
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
Title:
GNIS Identifier
The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey. -
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
StateCode(optional):
string
Title:
Code
Maximum Length:2
The unique state code. -
StateCodeISO(optional):
string
Title:
ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 standard. -
StateName(optional):
string
Title:
State Name
Maximum Length:60
The state name. -
StateSubdivisionCode(optional):
string
Title:
Subdivision 2 ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard. -
SubdivisionType(optional):
integer(int32)
Title:
Type
The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorStates-item
Type:
Show Source
object
-
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the state. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the state. -
CreationDate(optional):
string(date-time)
The date and time that the state was created.
-
DeletedFlag(optional):
boolean
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the state was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the state. -
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
Title:
GNIS Identifier
The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey. -
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
StateCode(optional):
string
Title:
Code
Maximum Length:2
The unique state code. -
StateCodeISO(optional):
string
Title:
ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 standard. -
StateName(optional):
string
Title:
State Name
Maximum Length:60
The state name. -
StateSubdivisionCode(optional):
string
Title:
Subdivision 2 ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard. -
SubdivisionType(optional):
integer(int32)
Title:
Type
The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.