Jump to

• Request
• Response

Update a menu item attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Attributes/{AttributesUniqID}

Request

Path Parameters

• AttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- RegistryName, ItemName and AttributeId ---for the Menu Item Attributes resource and used to uniquely identify an instance of Menu Item Attributes. The client should not generate the hash key value. Instead, the client should query on the Menu Item Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Menu Item Attributes.
  
  For example: Attributes?q=RegistryName=<value1>;ItemName=<value2>;AttributeId=<value3>
• publicSectorRegistryItemDefinitionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- RegistryName and ItemName ---for the Menu Items resource and used to uniquely identify an instance of Menu Items. The client should not generate the hash key value. Instead, the client should query on the Menu Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Menu Items.
  
  For example: publicSectorRegistryItemDefinitions?q=RegistryName=<value1>;ItemName=<value2>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeLongValue: string
  The static long value of the menu item attribute.
• AttributeShortValue: string
  Maximum Length: 250

  The static short value of the menu item attribute.
• AttributeStringValue: string
  Maximum Length: 250

  The label of the menu item attribute.
• AttributeTypeValue: string
  Maximum Length: 4

  The type value of the menu item attribute.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  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.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":"4",
            "type":"string",
            "description":"The type value of the menu item attribute.",
            "nullable":false
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "AttributeStringValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The label of the menu item attribute.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "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.",
            "nullable":false,
            "default":false
        },
        "AttributeShortValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The static short value of the menu item attribute.",
            "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 : publicSectorRegistryItemDefinitions-Attributes-item-response

Type: object

Show Source

• AttributeId: string
  Maximum Length: 30

  The unique identifier of the menu item attribute.
• AttributeLongValue: string
  The static long value of the menu item attribute.
• AttributeShortValue: string
  Maximum Length: 250

  The static short value of the menu item attribute.
• AttributeStringValue: string
  Maximum Length: 250

  The label of the menu item attribute.
• AttributeTypeValue: string
  Maximum Length: 4

  The type value of the menu item attribute.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  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.
• ItemName: string
  Maximum Length: 30

  The unique identifier of the menu item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegistryName: string
  Maximum Length: 30

  The unique identifier of the menu.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":"4",
            "type":"string",
            "description":"The type value of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "AttributeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeStringValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The label of the menu item attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeShortValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The static short value of the menu item attribute.",
            "nullable":true,
            "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