Get a metadata model

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorOpaMetaDataModels-item-response
Type: object
Show Source
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The name of the user who created the metadata model.
  • The date on which the metadata model was created.
  • Title: Creation Date
    Read Only: true
    The date on which the metadata model was created.
  • 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.
  • Title: Description
    Maximum Length: 100
    The description of the metadata model.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The name of the user who last updated the metadata model.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date on which the metadata model was last updated.
  • Links
  • 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.
  • 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.
  • Title: Name
    Maximum Length: 30
    The name of the metadata model.
  • The identifier of the notification that is associated with the metadata model.
  • Maximum Length: 10
    The identifier of the owner who is associated with the metadata model.
  • 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.
  • 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.
  • 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 : 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 : publicSectorOpaMetaDataModels-MetaDataEntityRelationAccessor-item-response
Type: object
Show Source
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The name of the user who created the metadata entity relationship.
  • Title: Creation Date
    Read Only: true
    The date on which the metadata entity relationship was created.
  • 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.
  • 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
    Read Only: true
    The date on which the metadata entity relationship was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The name of the user who last updated the metadata entity relationship.
  • Links
  • Title: Name
    Maximum Length: 30
    The name of the metadata model that is associated with the entity model.
  • 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.
  • Maximum Length: 10
    The identifier of the owner who is associated with the metadata entity relationship.
  • 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.
  • 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 : publicSectorOpaMetaDataModels-MetaDataModelEnumRelation-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The name of the user who created the metadata enumeration relationship.
  • The date on which the metadata enumeration relationship was created.
  • Title: Creation Date
    Read Only: true
    The date on which the metadata enumeration relationship was created.
  • 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.
  • Title: Enumeration Name
    Maximum Length: 30
    The name of the enumeration.
  • Title: Last Updated Date
    Read Only: true
    The date on which the metadata enumeration relationship was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The name of the user who last updated the metadata enumeration relationship.
  • Links
  • Title: Name
    Maximum Length: 30
    The metadata model associated with the enumeration.
  • Maximum Length: 10
    The identifier of the owner who is associated with the metadata enumeration relationship.
  • 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.
Back to Top