Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Configuration":{
            "title":"Configuration",
            "type":"string",
            "description":"The grid personalization data stored in json format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "GridTitle":{
            "title":"Grid Title",
            "maxLength":250,
            "type":"string",
            "description":"The title of the grid for which personalization is applied.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorGridPersonalizations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Configuration":{
            "title":"Configuration",
            "type":"string",
            "description":"The grid personalization data stored in json format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "GridTitle":{
            "title":"Grid Title",
            "maxLength":250,
            "type":"string",
            "description":"The title of the grid for which personalization is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GridTitleLabel":{
            "maxLength":255,
            "type":"string",
            "description":"The label of the grid title for which personalization is applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PageName":{
            "maxLength":255,
            "type":"string",
            "description":"The page name of the grid for which personalization is applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonalizationKey":{
            "title":"Personalization Key",
            "type":"integer",
            "description":"Unique surrogate identifier generated by the system for a particular row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ComponentId":{
            "title":"Component Identifier",
            "maxLength":200,
            "type":"string",
            "description":"The component identifier of a grid enabled for personalization.",
            "nullable":false,
            "x-queryable":true
        },
        "RegistryItem":{
            "title":"Registry Item",
            "maxLength":100,
            "type":"string",
            "description":"The fully qualified name of the page registered in the Public Sector Licensing and Permitting navigation registry.",
            "nullable":false,
            "x-queryable":true
        },
        "PersonalizationType":{
            "title":"Personalization Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of personalization for the grid.",
            "nullable":false,
            "default":"ORA_PER",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top