Jump to

• Request
• Response

Get all metadata entity links

get

/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>

Query Parameters

• dependency: string
  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>
• 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 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the record that matches the specified primary key.
    Finder Variables:
    • EntityModelName; string; The name of the source entity model.
    • MetaDataModelName; string; The name of the metadata model.
    • TargetEntityModelName; string; The name of the target entity model.
    • TargetEntityName; string; The name of the target entity.
  • SimpleSearchFinder: Finds the target entity model that matches the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find the target entity model that matches the specified entity model name or description.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Cardinality; string; 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; The name of the user who created the metadata entity link.
  • CreationDate; string; The date on which the metadata entity link was created.
  • DeletedFlag; string; 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; The name of the relationship that exists between the source entity and the target entity within the associated metadata model.
  • EntityModelName; string; The name of the source entity model.
  • EntityName; string; The name of the source entity.
  • LastUpdateDate; string; The date on which the metadata entity link was last updated.
  • LastUpdatedBy; string; The name of the user who last updated the metadata entity link.
  • MetaDataModelName; string; The name of the metadata model that is associated with the source and the target entity models.
  • OpaLinkName; string; 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; The identifier of the owner who is associated with the metadata entity link.
  • SeedDataLock; integer; 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; The name of the target entity model.
  • TargetEntityName; string; The name of the target entity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-item-response"
    }
}

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 : publicSectorOpaMetaDataEntityRelationships-MetaDataEntityLinkAccessor-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 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.

{
    "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 name of the relationship that exists between the source entity and the target entity within the associated metadata model.",
            "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 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
        },
        "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 name of the metadata model that is associated with the source and the 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 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
        },
        "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 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.",
            "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