Get an entity
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService/{EntityServiceUniqID}
Request
Path Parameters
-
EntityModelName: string
The name of the entity model.
-
EntityServiceUniqID: 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: EntityService?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).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorOpaEntityModels-EntityService-item
Type:
Show Source
object
-
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 Technology Stack. 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 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 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 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, and N for 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 associated with the entity from which the default values will be dynamically loaded.
-
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 type if relationship between the entity and its parent entity in the associated entity model. -
OpaName(optional):
string
Title:
Policy Modeling Name
Maximum Length:100
The name as displayed in the Policy Modeler for the entity. -
OwnerId(optional):
string
Maximum Length:
10
The identifier of the owner who 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 the 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 a 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 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.
Nested Schema : link
Type:
Show Source
object
-
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.