Update a grid personalization
patch
/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations/{PersonalizationKey}
Request
Path Parameters
-
PersonalizationKey(required): integer(int64)
Unique surrogate identifier generated by the system for a particular row.
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
-
Configuration: string
(byte)
Title:
Configuration
The grid personalization data stored in json format. -
GridTitle: string
Title:
Grid Title
Maximum Length:250
The title of the grid for which personalization is applied.
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 : publicSectorGridPersonalizations-item-response
Type:
Show Source
object
-
ComponentId: string
Title:
Component Identifier
Maximum Length:200
The component identifier of a grid enabled for personalization. -
Configuration: string
(byte)
Title:
Configuration
The grid personalization data stored in json format. -
GridTitle: string
Title:
Grid Title
Maximum Length:250
The title of the grid for which personalization is applied. -
GridTitleLabel: string
Read Only:
true
Maximum Length:255
The label of the grid title for which personalization is applied. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageName: string
Read Only:
true
Maximum Length:255
The page name of the grid for which personalization is applied. -
PersonalizationKey: integer
(int64)
Title:
Personalization Key
Unique surrogate identifier generated by the system for a particular row. -
PersonalizationType: string
Title:
Personalization Type
Maximum Length:30
Default Value:ORA_PER
The type of personalization for the grid. -
RegistryItem: string
Title:
Registry Item
Maximum Length:100
The fully qualified name of the page registered in the Public Sector Licensing and Permitting navigation registry.
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.