Jump to

• Request
• Response

Create a menu item customer configuration data record

post

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions/{publicSectorRegistryItemDefinitionsUniqID}/child/Configurations

Request

Supported Media Types

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

Path Parameters

• publicSectorRegistryItemDefinitionsUniqID: integer
  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>

Body ()

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

Root Schema : publicSectorRegistryItemDefinitions-Configurations-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this menu item attribute customization data.
• AttributeId(optional): string
  Maximum Length: 30

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

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

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

  The type value of the menu item attribute.
• 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.
• ItemName(optional): string
  Maximum Length: 30

  The unique identifier of the menu item.
• links(optional): array Items
  Title: Items

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

  The unique identifier of the menu.
• 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":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this menu item attribute customization data."
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu item attribute."
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute."
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the menu item attribute."
        },
        "AttributeStringValue":{
            "maxLength":250,
            "type":"string",
            "description":"The label of the menu item attribute."
        },
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the menu item attribute."
        },
        "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."
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu item."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu."
        },
        "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 : 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"
}

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 : publicSectorRegistryItemDefinitions-Configurations-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this menu item attribute customization data.
• AttributeId(optional): string
  Maximum Length: 30

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

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

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

  The type value of the menu item attribute.
• 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.
• ItemName(optional): string
  Maximum Length: 30

  The unique identifier of the menu item.
• links(optional): array Items
  Title: Items

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

  The unique identifier of the menu.
• 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":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this menu item attribute customization data."
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu item attribute."
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute."
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the menu item attribute."
        },
        "AttributeStringValue":{
            "maxLength":250,
            "type":"string",
            "description":"The label of the menu item attribute."
        },
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the menu item attribute."
        },
        "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."
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu item."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the menu."
        },
        "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 : 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"
}

Back to Top