1. REST API for Oracle Public Sector Compliance and Regulation Cloud
  2. Tasks
  3. Metadata Entity Relationships

Get all metadata entity relationships

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships

Request

Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • SimpleSearchFinder: Finds the entity model that matches the specified keyword. Finder Variables:
      • value; string; The keyword used to find the entity model that matches the specified entity model name.
    • PrimaryKey: Finds the entity model that matches the specified primary key. Finder Variables:
      • EntityModelName; string; The name of the entity model.
      • MetaDataModelName; string; The name of the metadata model.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorOpaMetaDataEntityRelationships
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorOpaMetaDataEntityRelationships-item
Type: object
Show Source
  • Title: Cardinality with Global Entity
    Maximum Length: 5
    Indicates the cardinality of the entity model with the global entity model in the associated metadata 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: Created By
    Maximum Length: 64
    The name of the user who created the metadata entity relationship.
  • Title: Creation Date
    The date on which the metadata entity relationship was created.
  • Maximum Length: 1
    Indicates if the metadata entity relationship is logically deleted. Valid values are Y for deleted, and N for existing metadata entity relationship. The default value is N.
  • Title: Name
    Maximum Length: 30
    The name of the entity model.
  • Title: Mark as Global Entity
    Maximum Length: 1
    Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.
  • Title: Last Updated Date
    The date on which the metadata entity relationship was last updated.
  • Title: Last Updated By
    Maximum Length: 64
    The name of the user who last updated the metadata entity relationship.
  • Items
  • Metadata Entity Links
    Title: Metadata Entity Links
    The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models within the Oracle Policy Automation configuration schema. Every entity model is associated with one or more metadata models that exist in the configuration schema.
  • Title: Name
    Maximum Length: 30
    The name of the metadata model associated with the entity model.
  • Title: Policy Modeling Relationship Name
    Maximum Length: 100
    The name of the relationship as shown in the policy modeler. This is the relationship that exists between the entity model and the global entity model within the associated metadata model.
  • Maximum Length: 10
    The identifier of the owner who is associated with the metadata entity relationship.
  • Indicates if the metadata entity relationship 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.
  • Title: Show User-Defined Attributes
    Maximum Length: 1
    Indicates if only the user-defined attributes should be displayed. Valid values are Y or N.
Nested Schema : Metadata Entity Links
Type: array
Title: Metadata Entity Links
The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models within the Oracle Policy Automation configuration schema. Every entity model is associated with one or more metadata models that exist in the configuration schema.
Show Source
Nested Schema : publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-item
Type: object
Show Source
Back to Top