Jump to

• Request
• Response

Create a grid personalization

post

/fscmRestApi/resources/11.13.18.05/publicSectorGridPersonalizations

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorGridPersonalizations-item

Type: object

Show Source

• ComponentId(optional): string
  Title: Component Identifier

  Maximum Length: 200

  The component identifier of a grid enabled for personalization.
• Configuration(optional): string
  Title: Configuration

  The grid personalization data stored in json format.
• GridTitle(optional): string
  Title: Grid Title

  Maximum Length: 250

  The title of the grid for which personalization is applied.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonalizationKey(optional): integer(int64)
  Title: Personalization Key

  Unique surrogate identifier generated by the system for a particular row.
• RegistryItem(optional): 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":{
        "ComponentId":{
            "title":"Component Identifier",
            "description":"The component identifier of a grid enabled for personalization.",
            "type":"string",
            "maxLength":200
        },
        "Configuration":{
            "title":"Configuration",
            "description":"The grid personalization data stored in json format.",
            "type":"string"
        },
        "GridTitle":{
            "title":"Grid Title",
            "description":"The title of the grid for which personalization is applied.",
            "type":"string",
            "maxLength":250
        },
        "PersonalizationKey":{
            "title":"Personalization Key",
            "description":"Unique surrogate identifier generated by the system for a particular row.",
            "type":"integer",
            "format":"int64"
        },
        "RegistryItem":{
            "title":"Registry Item",
            "description":"The fully qualified name of the page registered in the Public Sector Licensing and Permitting navigation registry.",
            "type":"string",
            "maxLength":100
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorGridPersonalizations-item

Type: object

Show Source

• ComponentId(optional): string
  Title: Component Identifier

  Maximum Length: 200

  The component identifier of a grid enabled for personalization.
• Configuration(optional): string
  Title: Configuration

  The grid personalization data stored in json format.
• GridTitle(optional): string
  Title: Grid Title

  Maximum Length: 250

  The title of the grid for which personalization is applied.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonalizationKey(optional): integer(int64)
  Title: Personalization Key

  Unique surrogate identifier generated by the system for a particular row.
• RegistryItem(optional): 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":{
        "ComponentId":{
            "title":"Component Identifier",
            "description":"The component identifier of a grid enabled for personalization.",
            "type":"string",
            "maxLength":200
        },
        "Configuration":{
            "title":"Configuration",
            "description":"The grid personalization data stored in json format.",
            "type":"string"
        },
        "GridTitle":{
            "title":"Grid Title",
            "description":"The title of the grid for which personalization is applied.",
            "type":"string",
            "maxLength":250
        },
        "PersonalizationKey":{
            "title":"Personalization Key",
            "description":"Unique surrogate identifier generated by the system for a particular row.",
            "type":"integer",
            "format":"int64"
        },
        "RegistryItem":{
            "title":"Registry Item",
            "description":"The fully qualified name of the page registered in the Public Sector Licensing and Permitting navigation registry.",
            "type":"string",
            "maxLength":100
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top