Create a se of metadata entity links
post
/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityRelationships/{publicSectorOpaMetaDataEntityRelationshipsUniqID}/child/MetaDataEntityLinkAccessor
Request
Path Parameters
-
publicSectorOpaMetaDataEntityRelationshipsUniqID(required): string
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: publicSectorOpaMetaDataEntityRelationships?q=EntityModelName=<value1>;MetaDataModelName=<value2>
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Cardinality: string
Title:
Cardinality with Target Entity
Maximum Length:10
Indicates the cardinality of the source entity with the target entity 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. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the metadata entity link is logically deleted. Valid values are Y for deleted, and N for existing metadata entity link. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The name of the relationship that exists between the source entity and the target entity within the associated metadata model. -
EntityModelName: string
Title:
Name
Maximum Length:30
The name of the source entity model. -
EntityName: string
Title:
Source Entity Policy Modeling Name
Maximum Length:30
The name of the source entity. -
MetaDataModelName: string
Title:
Name
Maximum Length:30
The name of the metadata model that is associated with the source and the target entity models. -
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 that exists between the source entity and the target entity within the associated metadata model. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the metadata entity link. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the metadata entity link 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. -
TargetEntityModelName: string
Title:
Target Entity Model Name
Maximum Length:30
The name of the target entity model. -
TargetEntityName: string
Title:
Target Entity Policy Modeling Name
Maximum Length:30
The name of the target entity.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-item-response
Type:
Show Source
object
-
Cardinality: string
Title:
Cardinality with Target Entity
Maximum Length:10
Indicates the cardinality of the source entity with the target entity 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 link. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the metadata entity link was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the metadata entity link is logically deleted. Valid values are Y for deleted, and N for existing metadata entity link. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The name of the relationship that exists between the source entity and the target entity within the associated metadata model. -
EntityModelName: string
Title:
Name
Maximum Length:30
The name of the source entity model. -
EntityName: string
Title:
Source Entity Policy Modeling Name
Maximum Length:30
The name of the source entity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the metadata entity link 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 link. -
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 source and the target entity models. -
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 that exists between the source entity and the target entity within the associated metadata model. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the metadata entity link. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the metadata entity link 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. -
TargetEntityModelName: string
Title:
Target Entity Model Name
Maximum Length:30
The name of the target entity model. -
TargetEntityName: string
Title:
Target Entity Policy Modeling Name
Maximum Length:30
The name of the target entity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.