Jump to

• Request
• Response

Update a metadata entity relationship

patch

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

Request

Path Parameters

• MetaDataEntityRelationAccessorUniqID(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: MetaDataEntityRelationAccessor?q=EntityModelName=<value1>;MetaDataModelName=<value2>
• MetaDataModelName(required): string
  The name of the metadata model.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CardinalityWithGlobal":{
            "title":"Cardinality with Global Entity",
            "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.",
            "nullable":true
        },
        "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.",
            "nullable":false,
            "default":"N"
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model.",
            "nullable":false
        },
        "GlobalEntityFlag":{
            "title":"Mark as Global Entity",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.",
            "nullable":true
        },
        "MetaDataModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the metadata model that is associated with the entity model.",
            "nullable":false
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "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.",
            "nullable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the metadata entity relationship.",
            "nullable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "ShowCustomAttrsOnly":{
            "title":"Show User-Defined Attributes",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if only user-defined attributes will be displayed. Valid values are Y or N.",
            "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:
  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.

Body ()

Root Schema : publicSectorOpaMetaDataModels-MetaDataEntityRelationAccessor-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CardinalityWithGlobal":{
            "title":"Cardinality with Global Entity",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the metadata entity relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the metadata entity relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "EntityModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model.",
            "nullable":false,
            "x-queryable":true
        },
        "GlobalEntityFlag":{
            "title":"Mark as Global Entity",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the entity model is the designated global entity model for the associated metadata model. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the metadata entity relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the metadata entity relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetaDataModelName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the metadata model that is associated with the entity model.",
            "nullable":false,
            "x-queryable":true
        },
        "OpaLinkName":{
            "title":"Policy Modeling Relationship Name",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the metadata entity relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ShowCustomAttrsOnly":{
            "title":"Show User-Defined Attributes",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if only user-defined attributes will be displayed. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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