Jump to

• Request
• Response

Update an entity attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorOpaEntityAttributesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- EntityModelName, EntityName and EntityAttributeName ---for the Entity Attributes resource and used to uniquely identify an instance of Entity Attributes. The client should not generate the hash key value. Instead, the client should query on the Entity Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Entity Attributes.
  
  For example: publicSectorOpaEntityAttributes?q=EntityModelName=<value1>;EntityName=<value2>;EntityAttributeName=<value3>

Body ()

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

Root Schema : publicSectorOpaEntityAttributes-item

Type: object

Show Source

• CanBeInput(optional): string
  Title: Use as Mapped in Attribute

  Maximum Length: 1

  Indicates if the entity attribute is mapped in as input attribute in the Policy Modeler. Valid values are Y or N.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Attribute

  Maximum Length: 1

  Indicates whether the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y or N.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the entity attribute.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the entity attribute was created.
• DataType(optional): string
  Title: Data Type

  Maximum Length: 50

  The data type of the entity attribute.
• DefaultValue(optional): string
  Title: Default Value

  Maximum Length: 100

  The default value for the entity attribute.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
• EntityAttributeName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity attribute.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model associated with the entity attribute.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity associated with the entity attribute.
• IsCustomAttribute(optional): string
  Title: Enumeration Attribute

  Maximum Length: 1

  Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.
• IsPrimaryKey(optional): string
  Title: Primary Key

  Maximum Length: 1

  Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the entity attribute was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the entity attribute.
• links(optional): array Items
  Title: Items

  Link Relations
• NotificationId(optional): string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity attribute.
• OpaDataType(optional): string
  Title: Policy Modeling Data Type

  Maximum Length: 20

  The data type as displayed in the Policy Modeler for the entity attribute.
• OpaEnumName(optional): string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration that is associated with the entity attribute.
• OpaHidden(optional): string
  Title: Hidden from Policy Modeling

  Maximum Length: 1

  Indicates if the entity attribute is hidden from policy modeling. If the value is Y, then it is a hidden attribute. The default value is N.
• OpaIsRequired(optional): string
  Title: Mandatory

  Maximum Length: 1

  Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y or N.
• OpaName(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name of the policy modeler for the entity attribute.
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity attribute.
• SeedDataLock(optional): integer(int32)
  Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "CanBeInput":{
            "title":"Use as Mapped in Attribute",
            "description":"Indicates if the entity attribute is mapped in as input attribute in the Policy Modeler. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "CanBeOutput":{
            "title":"Use as Mapped Out Attribute",
            "description":"Indicates whether the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the entity attribute.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date on which the entity attribute was created.",
            "type":"string",
            "format":"date-time"
        },
        "DataType":{
            "title":"Data Type",
            "description":"The data type of the entity attribute.",
            "type":"string",
            "maxLength":50
        },
        "DefaultValue":{
            "title":"Default Value",
            "description":"The default value for the entity attribute.",
            "type":"string",
            "maxLength":100
        },
        "DeletedFlag":{
            "description":"Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "EntityAttributeName":{
            "title":"Name",
            "description":"The name of the entity attribute.",
            "type":"string",
            "maxLength":40
        },
        "EntityModelName":{
            "title":"Name",
            "description":"The name of the entity model associated with the entity attribute.",
            "type":"string",
            "maxLength":30
        },
        "EntityName":{
            "title":"Name",
            "description":"The name of the entity associated with the entity attribute.",
            "type":"string",
            "maxLength":40
        },
        "IsCustomAttribute":{
            "title":"Enumeration Attribute",
            "description":"Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "IsPrimaryKey":{
            "title":"Primary Key",
            "description":"Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date on which the entity attribute was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the entity attribute.",
            "type":"string",
            "maxLength":64
        },
        "NotificationId":{
            "description":"The identifier of the notification that is associated with the entity attribute.",
            "type":"string",
            "maxLength":15
        },
        "OpaDataType":{
            "title":"Policy Modeling Data Type",
            "description":"The data type as displayed in the Policy Modeler for the entity attribute.",
            "type":"string",
            "maxLength":20
        },
        "OpaEnumName":{
            "title":"Enumeration Name",
            "description":"The name of the enumeration that is associated with the entity attribute.",
            "type":"string",
            "maxLength":30
        },
        "OpaHidden":{
            "title":"Hidden from Policy Modeling",
            "description":"Indicates if the entity attribute is hidden from policy modeling. If the value is Y, then it is a hidden attribute. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "OpaIsRequired":{
            "title":"Mandatory",
            "description":"Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "OpaName":{
            "title":"Policy Modeling Name",
            "description":"The name of the policy modeler for the entity attribute.",
            "type":"string",
            "maxLength":100
        },
        "OwnerId":{
            "description":"The identifier of the owner who is associated with the entity attribute.",
            "type":"string",
            "maxLength":10
        },
        "SeedDataLock":{
            "description":"Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "type":"integer",
            "format":"int32"
        },
        "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 : publicSectorOpaEntityAttributes-item

Type: object

Show Source

• CanBeInput(optional): string
  Title: Use as Mapped in Attribute

  Maximum Length: 1

  Indicates if the entity attribute is mapped in as input attribute in the Policy Modeler. Valid values are Y or N.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Attribute

  Maximum Length: 1

  Indicates whether the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y or N.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the entity attribute.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the entity attribute was created.
• DataType(optional): string
  Title: Data Type

  Maximum Length: 50

  The data type of the entity attribute.
• DefaultValue(optional): string
  Title: Default Value

  Maximum Length: 100

  The default value for the entity attribute.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
• EntityAttributeName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity attribute.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model associated with the entity attribute.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity associated with the entity attribute.
• IsCustomAttribute(optional): string
  Title: Enumeration Attribute

  Maximum Length: 1

  Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.
• IsPrimaryKey(optional): string
  Title: Primary Key

  Maximum Length: 1

  Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the entity attribute was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the entity attribute.
• links(optional): array Items
  Title: Items

  Link Relations
• NotificationId(optional): string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity attribute.
• OpaDataType(optional): string
  Title: Policy Modeling Data Type

  Maximum Length: 20

  The data type as displayed in the Policy Modeler for the entity attribute.
• OpaEnumName(optional): string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration that is associated with the entity attribute.
• OpaHidden(optional): string
  Title: Hidden from Policy Modeling

  Maximum Length: 1

  Indicates if the entity attribute is hidden from policy modeling. If the value is Y, then it is a hidden attribute. The default value is N.
• OpaIsRequired(optional): string
  Title: Mandatory

  Maximum Length: 1

  Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y or N.
• OpaName(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name of the policy modeler for the entity attribute.
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity attribute.
• SeedDataLock(optional): integer(int32)
  Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "CanBeInput":{
            "title":"Use as Mapped in Attribute",
            "description":"Indicates if the entity attribute is mapped in as input attribute in the Policy Modeler. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "CanBeOutput":{
            "title":"Use as Mapped Out Attribute",
            "description":"Indicates whether the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the entity attribute.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date on which the entity attribute was created.",
            "type":"string",
            "format":"date-time"
        },
        "DataType":{
            "title":"Data Type",
            "description":"The data type of the entity attribute.",
            "type":"string",
            "maxLength":50
        },
        "DefaultValue":{
            "title":"Default Value",
            "description":"The default value for the entity attribute.",
            "type":"string",
            "maxLength":100
        },
        "DeletedFlag":{
            "description":"Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "EntityAttributeName":{
            "title":"Name",
            "description":"The name of the entity attribute.",
            "type":"string",
            "maxLength":40
        },
        "EntityModelName":{
            "title":"Name",
            "description":"The name of the entity model associated with the entity attribute.",
            "type":"string",
            "maxLength":30
        },
        "EntityName":{
            "title":"Name",
            "description":"The name of the entity associated with the entity attribute.",
            "type":"string",
            "maxLength":40
        },
        "IsCustomAttribute":{
            "title":"Enumeration Attribute",
            "description":"Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "IsPrimaryKey":{
            "title":"Primary Key",
            "description":"Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date on which the entity attribute was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the entity attribute.",
            "type":"string",
            "maxLength":64
        },
        "NotificationId":{
            "description":"The identifier of the notification that is associated with the entity attribute.",
            "type":"string",
            "maxLength":15
        },
        "OpaDataType":{
            "title":"Policy Modeling Data Type",
            "description":"The data type as displayed in the Policy Modeler for the entity attribute.",
            "type":"string",
            "maxLength":20
        },
        "OpaEnumName":{
            "title":"Enumeration Name",
            "description":"The name of the enumeration that is associated with the entity attribute.",
            "type":"string",
            "maxLength":30
        },
        "OpaHidden":{
            "title":"Hidden from Policy Modeling",
            "description":"Indicates if the entity attribute is hidden from policy modeling. If the value is Y, then it is a hidden attribute. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "OpaIsRequired":{
            "title":"Mandatory",
            "description":"Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y or N.",
            "type":"string",
            "maxLength":1
        },
        "OpaName":{
            "title":"Policy Modeling Name",
            "description":"The name of the policy modeler for the entity attribute.",
            "type":"string",
            "maxLength":100
        },
        "OwnerId":{
            "description":"The identifier of the owner who is associated with the entity attribute.",
            "type":"string",
            "maxLength":10
        },
        "SeedDataLock":{
            "description":"Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "type":"integer",
            "format":"int32"
        },
        "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