Jump to

• Request
• Response

Update a menu

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}

Request

Supported Media Types

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

Path Parameters

• RegistryName: string
  The unique idenfitier of the menu.

Body ()

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

Root Schema : publicSectorRegistryDefinitions-item

Type: object

Show Source

• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false.
• Description(optional): string
  Maximum Length: 100

  The full descripion of the menu.
• HostName(optional): string
  Maximum Length: 30

  The web application that uses the menu for navigation.
• Label(optional): string
  Maximum Length: 30

  The short descripion of the menu.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique idenfitier of the menu.
• Securities(optional): array Menu Security Assignments
  Title: Menu Security Assignments

  The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term "menu" is also referred to as a "registry".
• SeedDataLock(optional): integer(int32)
  Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0.

{
    "properties":{
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full descripion of the menu."
        },
        "HostName":{
            "maxLength":30,
            "type":"string",
            "description":"The web application that uses the menu for navigation."
        },
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short descripion of the menu."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique idenfitier of the menu."
        },
        "Securities":{
            "items":{
                "$ref":"#/definitions/publicSectorRegistryDefinitions-Securities-item"
            },
            "type":"array",
            "description":"The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term \"menu\" is also referred to as a \"registry\".",
            "title":"Menu Security Assignments"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Menu Security Assignments

Type: array

Title: Menu Security Assignments

The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term "menu" is also referred to as a "registry".

Show Source

• Array of: object publicSectorRegistryDefinitions-Securities-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRegistryDefinitions-Securities-item"
    },
    "type":"array",
    "description":"The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term \"menu\" is also referred to as a \"registry\".",
    "title":"Menu Security Assignments"
}

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.

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

Nested Schema : publicSectorRegistryDefinitions-Securities-item

Type: object

Show Source

• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the menu.
• RoleName(optional): string
  Maximum Length: 250

  The unique identifier of the menu security assignment.

{
    "properties":{
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu."
        },
        "RoleName":{
            "maxLength":250,
            "type":"string",
            "description":"The unique identifier of the menu security assignment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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 : publicSectorRegistryDefinitions-item

Type: object

Show Source

• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false.
• Description(optional): string
  Maximum Length: 100

  The full descripion of the menu.
• HostName(optional): string
  Maximum Length: 30

  The web application that uses the menu for navigation.
• Label(optional): string
  Maximum Length: 30

  The short descripion of the menu.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique idenfitier of the menu.
• Securities(optional): array Menu Security Assignments
  Title: Menu Security Assignments

  The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term "menu" is also referred to as a "registry".
• SeedDataLock(optional): integer(int32)
  Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0.

{
    "properties":{
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full descripion of the menu."
        },
        "HostName":{
            "maxLength":30,
            "type":"string",
            "description":"The web application that uses the menu for navigation."
        },
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short descripion of the menu."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique idenfitier of the menu."
        },
        "Securities":{
            "items":{
                "$ref":"#/definitions/publicSectorRegistryDefinitions-Securities-item"
            },
            "type":"array",
            "description":"The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term \"menu\" is also referred to as a \"registry\".",
            "title":"Menu Security Assignments"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Menu Security Assignments

Type: array

Title: Menu Security Assignments

The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term "menu" is also referred to as a "registry".

Show Source

• Array of: object publicSectorRegistryDefinitions-Securities-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRegistryDefinitions-Securities-item"
    },
    "type":"array",
    "description":"The menu security assignments resource is used to view, create, modify, or delete a navigation menu security assignment. Note that this resource is no longer in use. Menu security assignments should be configured through the Security Console. The term \"menu\" is also referred to as a \"registry\".",
    "title":"Menu Security Assignments"
}

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.

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

Nested Schema : publicSectorRegistryDefinitions-Securities-item

Type: object

Show Source

• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the menu.
• RoleName(optional): string
  Maximum Length: 250

  The unique identifier of the menu security assignment.

{
    "properties":{
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu."
        },
        "RoleName":{
            "maxLength":250,
            "type":"string",
            "description":"The unique identifier of the menu security assignment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Back to Top