Jump to

• Request
• Response

Create a set of metadata entity links

post

/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataEntityLinks

Request

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Cardinality: string
  Title: Cardinality with Target Entity

  Maximum Length: 10

  Indicates the cardinality of the source entity with the target entity 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.
• 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 description of the metadata entity link.
• 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 metadata model associated with the source and target entity models.
• OpaLinkName: string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The name of the relationship between the source entity and the target entity in 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 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.

{
    "type":"object",
    "properties":{
        "TargetEntityName":{
            "title":"Target Entity Policy Modeling Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the target entity.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the metadata entity link.",
            "nullable":false
        },
        "Cardinality":{
            "title":"Cardinality with Target Entity",
            "maxLength":10,
            "type":"string",
            "description":"Indicates the cardinality of the source entity with the target entity 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.",
            "nullable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the metadata entity link.",
            "nullable":true
        },
        "EntityName":{
            "title":"Source Entity Policy Modeling Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source entity.",
            "nullable":true
        },
        "MetaDataModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The metadata model associated with the source and target entity models.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the metadata entity link 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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N"
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source entity model.",
            "nullable":false
        },
        "TargetEntityModelName":{
            "title":"Target Entity Model Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the target entity model.",
            "nullable":false
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the relationship between the source entity and the target entity in the associated metadata model.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorOpaMetaDataEntityLinks-item-response

Type: object

Show Source

• Cardinality: string
  Title: Cardinality with Target Entity

  Maximum Length: 10

  Indicates the cardinality of the source entity with the target entity 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.
• 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 description of the metadata entity link.
• 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 metadata model associated with the source and target entity models.
• OpaLinkName: string
  Title: Policy Modeling Relationship Name

  Maximum Length: 100

  The name of the relationship between the source entity and the target entity in 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 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the metadata entity link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the metadata entity link was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the metadata entity link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetEntityName":{
            "title":"Target Entity Policy Modeling Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the target entity.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the metadata entity link.",
            "nullable":false,
            "x-queryable":true
        },
        "Cardinality":{
            "title":"Cardinality with Target Entity",
            "maxLength":10,
            "type":"string",
            "description":"Indicates the cardinality of the source entity with the target entity 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.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityName":{
            "title":"Source Entity Policy Modeling Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source entity.",
            "nullable":true,
            "x-queryable":true
        },
        "MetaDataModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The metadata model associated with the source and target entity models.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the metadata entity link 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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source entity model.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetEntityModelName":{
            "title":"Target Entity Model Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the target entity model.",
            "nullable":false,
            "x-queryable":true
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the relationship between the source entity and the target entity in the associated metadata model.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the metadata entity link.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the metadata entity link was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top