Jump to

• Request
• Response

Get an entity

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntities/{publicSectorOpaEntitiesUniqID}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• BelongsToTechstack(optional): string
  Maximum Length: 1

  Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to the Technology Stack component. The default value is N.
• CanBeInput(optional): string
  Title: Use as Mapped in Entity

  Maximum Length: 1

  Indicates if the entity is mapped in as an input entity in the policy modeler. Valid values are Y or N.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Entity

  Maximum Length: 1

  Indicates if the entity is mapped out as an output entity in the policy modeler. Valid values are Y or N.
• CardinalityWithParent(optional): string
  Title: Cardinality with Parent Entity

  Maximum Length: 5

  Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date on which the entity was created.
• DeletedFlag(optional): string
  Maximum Length: 1

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

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId(optional): number
  The identifier of the View object that is associated with the entity from which the default values will be dynamically loaded.
• EntityAttributeService(optional): array Entity Attributes
  Title: Entity Attributes

  The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object that exists in the application schema. The entity attribute contains information about how the View object attribute is referred to and is used in the Oracle Policy Modeling tool.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

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

  Maximum Length: 40

  The name of the entity.
• IsTopLevel(optional): string
  Title: Top-Level Entity

  Maximum Length: 1

  Indicates if the entity is a top level entity in the Entity Model. If the value is Y, then it is a top level entity. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The name of the user who last updated the entity.
• 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.
• OpaHidden(optional): string
  Title: Hidden from Policy Modeling

  Maximum Length: 1

  Indicates if the entity is hidden from Policy Modeling. If the value is Y, then it is a hidden entity. The default value is N.
• OpaLinkName(optional): string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The name of the relationship that exists between the entity and its parent entity in the associated entity model.
• OpaName(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

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

  The identifier of the owner that is associated with the entity.
• ParentEoName(optional): string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock(optional): integer(int32)
  Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• SupportsAttachment(optional): string
  Title: Supports Attachment

  Maximum Length: 1

  Indicates if the entity supports the collection of attachments. Valid values are Y or N.
• SupportsDynamicLoad(optional): string
  Title: Supports Dynamic Default Values

  Maximum Length: 1

  Indicates if the entity supports the dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.
• ViewObjectId(optional): integer(int64)
  Title: View Object ID

  The identifier of the View object that is associated with the entity.

{
    "properties":{
        "BelongsToTechstack":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to the Technology Stack component. The default value is N."
        },
        "CanBeInput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped in as an input entity in the policy modeler. Valid values are Y or N.",
            "title":"Use as Mapped in Entity"
        },
        "CanBeOutput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped out as an output entity in the policy modeler. Valid values are Y or N.",
            "title":"Use as Mapped Out Entity"
        },
        "CardinalityWithParent":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.",
            "title":"Cardinality with Parent Entity"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the entity.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted entity, and N for an existing entity. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the entity.",
            "title":"Description"
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The identifier of the View object that is associated with the entity from which the default values will be dynamically loaded."
        },
        "EntityAttributeService":{
            "items":{
                "$ref":"#/definitions/publicSectorOpaEntities-EntityAttributeService-item"
            },
            "type":"array",
            "description":"The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object that exists in the application schema. The entity attribute contains information about how the View object attribute is referred to and is used in the Oracle Policy Modeling tool.",
            "title":"Entity Attributes"
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "title":"Name"
        },
        "EntityName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the entity.",
            "title":"Name"
        },
        "IsTopLevel":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is a top level entity in the Entity Model. If the value is Y, then it is a top level entity. The default value is N.",
            "title":"Top-Level Entity"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity.",
            "title":"Last Updated By"
        },
        "NotificationId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity."
        },
        "OpaHidden":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is hidden from Policy Modeling. If the value is Y, then it is a hidden entity. The default value is N.",
            "title":"Hidden from Policy Modeling"
        },
        "OpaLinkName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the relationship that exists between the entity and its parent entity in the associated entity model.",
            "title":"Policy Modeling Relationship Name"
        },
        "OpaName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the policy modeling for the entity.",
            "title":"Policy Modeling Name"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner that is associated with the entity."
        },
        "ParentEoName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "title":"Parent Entity Name"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified."
        },
        "SupportsAttachment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports the collection of attachments. Valid values are Y or N.",
            "title":"Supports Attachment"
        },
        "SupportsDynamicLoad":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports the dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.",
            "title":"Supports Dynamic Default Values"
        },
        "ViewObjectId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "title":"View Object ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Entity Attributes

Type: array

Title: Entity Attributes

The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object that exists in the application schema. The entity attribute contains information about how the View object attribute is referred to and is used in the Oracle Policy Modeling tool.

Show Source

• Array of: object publicSectorOpaEntities-EntityAttributeService-item

{
    "items":{
        "$ref":"#/definitions/publicSectorOpaEntities-EntityAttributeService-item"
    },
    "type":"array",
    "description":"The entity attributes resource is used to view attributes that belong to an entity. The entity attribute represents the attribute of a View object that exists in the application schema. The entity attribute contains information about how the View object attribute is referred to and is used in the Oracle Policy Modeling tool.",
    "title":"Entity Attributes"
}

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 : publicSectorOpaEntities-EntityAttributeService-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 and N. If the value is Y, then it is mapped in.
• CanBeOutput(optional): string
  Title: Use as Mapped Out Attribute

  Maximum Length: 1

  Indicates if the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped out.
• 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 an 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 that is associated with the entity attribute.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity that is 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 shown 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. Valid values are Y and N. 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 and N. If the value is Y, then it is a mandatory attribute.
• 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 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 and N. If the value is Y, then it is mapped in.",
            "title":"Use as Mapped in Attribute"
        },
        "CanBeOutput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y and N. If the value is Y, then it is mapped out.",
            "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 an 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 that is associated with the entity attribute.",
            "title":"Name"
        },
        "EntityName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the entity that is 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 shown 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. Valid values are Y and N. 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 and N. If the value is Y, then it is a mandatory attribute.",
            "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 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