Get all metadata models
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
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:- PrimaryKey: Finds the record that matches the primary key criteria.
Finder Variables:- MetaDataModelName; string; The name of the metadata model.
- SimpleSearchFinder: Finds the metadata model that matches the specified keyword.
Finder Variables:- value; string; The keyword used to find the metadata model that matches the specified metadata model name or description.
- PrimaryKey: Finds the record that matches the primary key criteria.
-
limit: integer
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. 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
-
q: string
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
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveModel; string; Indicates if the metadata model is available to use. If the value is Y, then it is available to use. The default value is N.
- CreatedBy; string; The name of the user who created the metadata model.
- CreatedOn; string; The date on which the metadata model was created.
- CreationDate; string; The date on which the metadata model was created.
- DeletedFlag; string; Indicates if the metadata model is logically deleted. Valid values are Y for deleted, and N for an existing metadata model. The default value is N.
- Description; string; The description of the metadata model.
- EditLocked; string; Indicates if the metadata model is unavailable for edit. If the value is Y, then it is unavailable for edit. The default value is N.
- LastUpdateDate; string; The name of the user who last updated the metadata model.
- LastUpdatedBy; string; The date on which the metadata model was last updated.
- MetaDataModelName; string; The name of the metadata model.
- NotificationId; number; The identifier of the notification that is associated with the metadata model.
- OwnerId; string; The identifier of the owner who is associated with the metadata model.
- SeedDataLock; integer; Indicates if the metadata 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.
- SupportsAnonymousSave; string; Indicates if anonymous users can save the interview outcome data for the policy models associated with the metadata model. If the value is Y, then the interview outcome data can be saved by anonymous users. The default value is N.
- SupportsCheckpoint; string; Indicates if the user can apply Checkpoint to the interviews for the policy models associated with the metadata model. If the value is Y, then Checkpoint can be applied to the interviews. The default value is N.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorOpaMetaDataModels
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorOpaMetaDataModels-item-response
Type:
Show Source
object
-
ActiveModel: string
Title:
Active Model
Maximum Length:1
Indicates if the metadata model is available to use. If the value is Y, then it is available to use. The default value is N. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the metadata model. -
CreatedOn: string
(date-time)
The date on which the metadata model was created.
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the metadata model was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the metadata model is logically deleted. Valid values are Y for deleted, and N for an existing metadata model. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the metadata model. -
EditLocked: string
Title:
Read-Only
Maximum Length:1
Indicates if the metadata model is unavailable for edit. If the value is Y, then it is unavailable for edit. The default value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the metadata model. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date on which the metadata model was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetaDataEntityRelationAccessor: array
Metadata Entity Relationships
Title:
Metadata Entity Relationships
The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models that exist in the Oracle Policy Automation configuration schema. Each entity model is associated with one or more metadata models existing in the configuration schema. -
MetaDataModelEnumRelation: array
Metadata Enumeration Relationships
Title:
Metadata Enumeration Relationships
The metadata enumeration relationships resource is used to view the mapping that exists between the enumerations and the metadata models within the Oracle Policy Automation configuration schema. Each enumeration is associated with one or more metadata models existing in the configuration schema. -
MetaDataModelName: string
Title:
Name
Maximum Length:30
The name of the metadata model. -
NotificationId: number
The identifier of the notification that is associated with the metadata model.
-
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the metadata model. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the metadata 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. -
SupportsAnonymousSave: string
Title:
Anonymous Users Can Save Data
Maximum Length:1
Indicates if anonymous users can save the interview outcome data for the policy models associated with the metadata model. If the value is Y, then the interview outcome data can be saved by anonymous users. The default value is N. -
SupportsCheckpoint: string
Title:
Supports Policy Modeling Checkpoints
Maximum Length:1
Indicates if the user can apply Checkpoint to the interviews for the policy models associated with the metadata model. If the value is Y, then Checkpoint can be applied to the interviews. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Metadata Entity Relationships
Type:
array
Title:
Metadata Entity Relationships
The metadata entity relationships resource is used to view the mapping that exists between the entity models and the metadata models that exist in the Oracle Policy Automation configuration schema. Each entity model is associated with one or more metadata models existing in the configuration schema.
Show Source
Nested Schema : Metadata Enumeration Relationships
Type:
array
Title:
Metadata Enumeration Relationships
The metadata enumeration relationships resource is used to view the mapping that exists between the enumerations and the metadata models within the Oracle Policy Automation configuration schema. Each enumeration is associated with one or more metadata models existing in the configuration schema.
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.
Nested Schema : publicSectorOpaMetaDataModels-MetaDataEntityRelationAccessor-item-response
Type:
Show Source
object
-
CardinalityWithGlobal: string
Title:
Cardinality with Global Entity
Maximum Length:5
Indicates the cardinality of the entity model with the global entity model within 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the metadata entity relationship. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the metadata entity relationship was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the metadata entity relationship is logically deleted. Valid values are Y for deleted, and N for an existing metadata entity relationship. The default value is N. -
EntityModelName: string
Title:
Name
Maximum Length:30
The name of the entity model. -
GlobalEntityFlag: boolean
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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the metadata entity relationship was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the metadata entity relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetaDataModelName: string
Title:
Name
Maximum Length:30
The name of the metadata model that is associated with the entity model. -
OpaLinkName: string
Title:
Policy Modeling Relationship Name
Maximum Length:100
The name of the relationship as displayed in the policy modeler. This is the relationship between the entity model and the global entity model within the associated metadata model. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the metadata entity relationship. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the metadata entity relationship 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. -
ShowCustomAttrsOnly: string
Title:
Show User-Defined Attributes
Maximum Length:1
Indicates if only user-defined attributes will be displayed. Valid values are Y or N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorOpaMetaDataModels-MetaDataModelEnumRelation-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 metadata enumeration relationship. -
CreatedOn: string
(date-time)
The date on which the metadata enumeration relationship was created.
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the metadata enumeration relationship was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the metadata enumeration relationship is logically deleted. Valid values are Y for deleted, and N for an existing metadata enumeration relationship. The default value is N. -
EnumName: string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the metadata enumeration relationship was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the metadata enumeration relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetaDataModelName: string
Title:
Name
Maximum Length:30
The metadata model associated with the enumeration. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the metadata enumeration relationship. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the metadata enumeration relationship 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- getOPALoadData
-
Get the seed data to be loaded for a given metadata model name at the start of an Oracle Policy Automation interview.
- getOPAMetaData
-
Get the metadata model for a given metadata model name for the purpose of designing a policy model using Oracle Policy Modeler.
- getOPASaveData
-
Save the outcome data for a given metadata model name at the end of an Oracle Policy Automation interview.