Create a state
post
/fscmRestApi/resources/11.13.18.05/publicSectorStates
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the state. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
LocalityGnisId: 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: integer
(int32)
Default Value:
0
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: string
Title:
Code
Maximum Length:2
The unique state code. -
StateCodeISO: string
Title:
ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 standard. -
StateName: string
Title:
State Name
Maximum Length:60
The state name. -
StateSubdivisionCode: 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: integer
(int32)
Title:
Type
The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorStates-item-response
Type:
Show Source
object
-
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the state. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the state was created. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
(date-time)
Read Only:
true
The date and time that the state was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalityGnisId: 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: integer
(int32)
Default Value:
0
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: string
Title:
Code
Maximum Length:2
The unique state code. -
StateCodeISO: string
Title:
ISO Code
Maximum Length:6
The code for the state according to the ISO 3166-2 standard. -
StateName: string
Title:
State Name
Maximum Length:60
The state name. -
StateSubdivisionCode: 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: 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 : 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.