Jump to

• Request
• Response

Create a set of entity attributes

post

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes

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

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

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