Jump to

• Request
• Response

Update an entity model

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}

Request

Path Parameters

• EntityModelName(required): string
  The name of the entity model.

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

• CreatedOn: string (date-time)
  The date on which the entity model was created.
• CustomCreated: string
  Title: User-Defined

  Maximum Length: 1

  Indicates if the entity model is created by the user. If the value is Y, then it is user-created. The default value is N.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

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

  Maximum Length: 100

  The description of the entity model.
• EditLocked: string
  Title: Read-Only

  Maximum Length: 1

  Indicates if the entity model is not available for edit. If the value is Y, then it is read-only. The default value is N.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the entity model is available to use. If the value is Y, then it is enabled The default value is N.
• EntityModelName: string
  Title: Name

  Maximum Length: 30

  The name of the entity model.
• EntityService: array Entities
  Title: Entities

  The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.
• NotificationId: number
  The identifier of the notification that is associated with the entity model.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity model.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the entity model is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "EntityService":{
            "title":"Entities",
            "type":"array",
            "description":"The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEntityModels-EntityService-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the entity model.",
            "nullable":true
        },
        "EditLocked":{
            "title":"Read-Only",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is not available for edit. If the value is Y, then it is read-only. The default value is N.",
            "nullable":true
        },
        "NotificationId":{
            "type":"number",
            "description":"The identifier of the notification that is associated with the entity model.",
            "nullable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity model.",
            "nullable":true
        },
        "CustomCreated":{
            "title":"User-Defined",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is created by the user. If the value is Y, then it is user-created. The default value is N.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the entity model is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is logically deleted. Valid values are Y for deleted, and N for an existing entity model. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the entity model.",
            "nullable":false
        },
        "CreatedOn":{
            "type":"string",
            "description":"The date on which the entity model was created.",
            "format":"date-time",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the entity model is available to use. If the value is Y, then it is enabled The default value is N.",
            "nullable":true
        }
    }
}

Nested Schema : Entities

Type: array

Title: Entities

The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.

Show Source

• Array of: object publicSectorOpaEntityModels-EntityService-item-patch-request

{
    "title":"Entities",
    "type":"array",
    "description":"The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEntityModels-EntityService-item-patch-request"
    }
}

Nested Schema : publicSectorOpaEntityModels-EntityService-item-patch-request

Type: object

Show Source

• BelongsToTechstack: string
  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.
• CardinalityWithParent: 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.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

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

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId: number
  The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
• EntityModelName: string
  Title: Name

  Maximum Length: 30

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

  Maximum Length: 40

  The name of the entity.
• IsTopLevel: 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.
• NotificationId: string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity.
• OpaHidden: 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: string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The type if relationship between the entity and its parent entity in the associated entity model.
• OpaName: string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name as displayed in the Policy Modeler for the entity.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity.
• ParentEoName: string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• SupportsAttachment: string
  Title: Supports Attachment

  Maximum Length: 1

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

  Maximum Length: 1

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

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

{
    "type":"object",
    "properties":{
        "SupportsAttachment":{
            "title":"Supports Attachment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity supports a collection of attachments. Valid values are Y or N.",
            "nullable":true
        },
        "CanBeInput":{
            "title":"Use as Mapped in Entity",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the entity.",
            "nullable":true
        },
        "EntityName":{
            "title":"Name",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the entity.",
            "nullable":false
        },
        "NotificationId":{
            "maxLength":"15",
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "nullable":false
        },
        "ParentEoName":{
            "title":"Parent Entity Name",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "nullable":true
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "maxLength":"100",
            "type":"string",
            "description":"The type if relationship between the entity and its parent entity in the associated entity model.",
            "nullable":true
        },
        "OpaName":{
            "title":"Policy Modeling Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name as displayed in the Policy Modeler for the entity.",
            "nullable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity.",
            "nullable":true
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "IsTopLevel":{
            "title":"Top-Level Entity",
            "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.",
            "nullable":true
        },
        "OpaHidden":{
            "title":"Hidden from Policy Modeling",
            "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.",
            "nullable":true
        },
        "SupportsDynamicLoad":{
            "title":"Supports Dynamic Default Values",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.",
            "nullable":true
        },
        "CanBeOutput":{
            "title":"Use as Mapped Out Entity",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.",
            "nullable":true
        },
        "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 Technology Stack. The default value is N.",
            "nullable":true
        },
        "ViewObjectId":{
            "title":"View Object ID",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CardinalityWithParent":{
            "title":"Cardinality with Parent Entity",
            "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.",
            "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 : publicSectorOpaEntityModels-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the entity model.
• CreatedOn: string (date-time)
  The date on which the entity model was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which the entity model was created.
• CustomCreated: string
  Title: User-Defined

  Maximum Length: 1

  Indicates if the entity model is created by the user. If the value is Y, then it is user-created. The default value is N.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

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

  Maximum Length: 100

  The description of the entity model.
• EditLocked: string
  Title: Read-Only

  Maximum Length: 1

  Indicates if the entity model is not available for edit. If the value is Y, then it is read-only. The default value is N.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the entity model is available to use. If the value is Y, then it is enabled The default value is N.
• EntityModelName: string
  Title: Name

  Maximum Length: 30

  The name of the entity model.
• EntityService: array Entities
  Title: Entities

  The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The name of the user who last updated the entity model.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date on which the entity model was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationId: number
  The identifier of the notification that is associated with the entity model.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity model.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the entity model is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date on which the entity model was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the entity model was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityService":{
            "title":"Entities",
            "type":"array",
            "description":"The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEntityModels-EntityService-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the entity model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the entity model.",
            "nullable":true,
            "x-queryable":true
        },
        "EditLocked":{
            "title":"Read-Only",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is not available for edit. If the value is Y, then it is read-only. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"number",
            "description":"The identifier of the notification that is associated with the entity model.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomCreated":{
            "title":"User-Defined",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is created by the user. If the value is Y, then it is user-created. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the entity model is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the entity model.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity model.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity model is logically deleted. Valid values are Y for deleted, and N for an existing entity model. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedOn":{
            "type":"string",
            "description":"The date on which the entity model was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the entity model is available to use. If the value is Y, then it is enabled The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the entity model.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Entities

Type: array

Title: Entities

The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.

Show Source

• Array of: object publicSectorOpaEntityModels-EntityService-item-response

{
    "title":"Entities",
    "type":"array",
    "description":"The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEntityModels-EntityService-item-response"
    }
}

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 : publicSectorOpaEntityModels-EntityService-item-response

Type: object

Show Source

• BelongsToTechstack: string
  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.
• CardinalityWithParent: 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: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Default Value: N

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

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId: number
  The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
• EntityModelName: string
  Title: Name

  Maximum Length: 30

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

  Maximum Length: 40

  The name of the entity.
• IsTopLevel: 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: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationId: string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity.
• OpaHidden: 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: string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The type if relationship between the entity and its parent entity in the associated entity model.
• OpaName: string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name as displayed in the Policy Modeler for the entity.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity.
• ParentEoName: string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• SupportsAttachment: string
  Title: Supports Attachment

  Maximum Length: 1

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

  Maximum Length: 1

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

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the entity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityName":{
            "title":"Name",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the entity.",
            "nullable":false,
            "x-queryable":true
        },
        "NotificationId":{
            "maxLength":"15",
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentEoName":{
            "title":"Parent Entity Name",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "OpaName":{
            "title":"Policy Modeling Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name as displayed in the Policy Modeler for the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupportsDynamicLoad":{
            "title":"Supports Dynamic Default Values",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CanBeOutput":{
            "title":"Use as Mapped Out Entity",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewObjectId":{
            "title":"View Object ID",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CardinalityWithParent":{
            "title":"Cardinality with Parent Entity",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportsAttachment":{
            "title":"Supports Attachment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity supports a collection of attachments. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "CanBeInput":{
            "title":"Use as Mapped in Entity",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of user who created the entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "maxLength":"100",
            "type":"string",
            "description":"The type if relationship between the entity and its parent entity in the associated entity model.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "IsTopLevel":{
            "title":"Top-Level Entity",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "OpaHidden":{
            "title":"Hidden from Policy Modeling",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "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 Technology Stack. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the entity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Links

EntityService

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService

Parameters:

• EntityModelName: $request.path.EntityModelName

The entities resource is used to view entities that belong to an entity model. The entity represents a View object present in the application schema. The entity also contains information about how the View object is referred to and used in the Oracle Policy Modeling tool.

Back to Top