Jump to

• Request
• Response

Get a metadata entity relationship

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels/{MetaDataModelName}/child/MetaDataEntityRelationAccessor/{MetaDataEntityRelationAccessorUniqID}

Request

Path Parameters

• MetaDataEntityRelationAccessorUniqID: integer
  This is the hash key of the attributes which make up the composite key--- EntityModelName and MetaDataModelName ---for the Metadata Entity Relationships resource and used to uniquely identify an instance of Metadata Entity Relationships. The client should not generate the hash key value. Instead, the client should query on the Metadata Entity Relationships collection resource with a filter on the primary key values in order to navigate to a specific instance of Metadata Entity Relationships.
  
  For example: MetaDataEntityRelationAccessor?q=EntityModelName=<value1>;MetaDataModelName=<value2>
• MetaDataModelName: string
  The name of the metadata model.

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).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaMetaDataModels-MetaDataEntityRelationAccessor-item

Type: object

Show Source

• CardinalityWithGlobal(optional): 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(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the metadata entity relationship.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the metadata entity relationship was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  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(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model.
• GlobalEntityFlag(optional): string
  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(optional): string(date-time)
  Title: Last Updated Date

  The date on which the metadata entity relationship was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the metadata entity relationship.
• links(optional): array Items
  Title: Items

  Link Relations
• MetaDataModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the metadata model that is associated with the entity model.
• OpaLinkName(optional): 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(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the metadata entity relationship.
• SeedDataLock(optional): integer(int32)
  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(optional): string
  Title: Show User-Defined Attributes

  Maximum Length: 1

  Indicates if only user-defined attributes will be displayed. Valid values are Y or N.

{
    "properties":{
        "CardinalityWithGlobal":{
            "maxLength":5,
            "type":"string",
            "description":"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":"Cardinality with Global Entity"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the metadata entity relationship.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the metadata entity relationship was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model.",
            "title":"Name"
        },
        "GlobalEntityFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.",
            "title":"Mark as Global Entity"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the metadata entity relationship was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the metadata entity relationship.",
            "title":"Last Updated By"
        },
        "MetaDataModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the metadata model that is associated with the entity model.",
            "title":"Name"
        },
        "OpaLinkName":{
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "title":"Policy Modeling Relationship Name"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the metadata entity relationship."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if only user-defined attributes will be displayed. Valid values are Y or N.",
            "title":"Show User-Defined Attributes"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top