Create a set of entity models
post
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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(required): 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.
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
Nested Schema : schema
Type:
Show Source
object
-
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.
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.
Root Schema : publicSectorOpaEntityModels-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorOpaEntityModels-EntityService-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- EntityService
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityServiceParameters:
- 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. - EntityModelName: