Get an entity attribute
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityAttributes/{publicSectorOpaEntityAttributesUniqID}
Request
Path Parameters
-
publicSectorOpaEntityAttributesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EntityModelName, EntityName and EntityAttributeName ---for the Entity Attributes resource and used to uniquely identify an instance of Entity Attributes. The client should not generate the hash key value. Instead, the client should query on the Entity Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Entity Attributes.
For example: publicSectorOpaEntityAttributes?q=EntityModelName=<value1>;EntityName=<value2>;EntityAttributeName=<value3>
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : publicSectorOpaEntityAttributes-item-response
Type:
Show Source
object
-
CanBeInput: string
Title:
Use as Mapped in Attribute
Maximum Length:1
Indicates if the entity attribute is mapped in as input attribute in the Policy Modeler. Valid values are Y or N. -
CanBeOutput: string
Title:
Use as Mapped Out Attribute
Maximum Length:1
Indicates whether the entity attribute is mapped out as output attribute in the policy modeler. Valid values are Y or N. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the entity attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the entity attribute was created. -
DataType: string
Title:
Data Type
Maximum Length:50
The data type of the entity attribute. -
DefaultValue: string
Title:
Default Value
Maximum Length:100
The default value for the entity attribute. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the entity attribute is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N. -
EntityAttributeName: string
Title:
Name
Maximum Length:40
The name of the entity attribute. -
EntityModelName: string
Title:
Name
Maximum Length:30
The name of the entity model associated with the entity attribute. -
EntityName: string
Title:
Name
Maximum Length:40
The name of the entity associated with the entity attribute. -
IsCustomAttribute: string
Title:
Enumeration Attribute
Maximum Length:1
Indicates if the entity attribute is a user-defined attribute. If the value is Y, then it is user-defined. The default value is N. -
IsPrimaryKey: string
Title:
Primary Key
Maximum Length:1
Indicates if the entity attribute is a primary key. If the value is Y, then it is a primary key. The default value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the entity attribute was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the entity attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotificationId: string
Maximum Length:
15
The identifier of the notification that is associated with the entity attribute. -
OpaDataType: string
Title:
Policy Modeling Data Type
Maximum Length:20
The data type as displayed in the Policy Modeler for the entity attribute. -
OpaEnumName: string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration that is associated with the entity attribute. -
OpaHidden: string
Title:
Hidden from Policy Modeling
Maximum Length:1
Indicates if the entity attribute is hidden from policy modeling. If the value is Y, then it is a hidden attribute. The default value is N. -
OpaIsRequired: string
Title:
Mandatory
Maximum Length:1
Indicates if the entity attribute is a mandatory attribute for policy modeling. Valid values are Y or N. -
OpaName: string
Title:
Policy Modeling Name
Maximum Length:100
The name of the policy modeler for the entity attribute. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the entity attribute. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the entity attribute is a seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
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.