Get a data security profile assignment
get
/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}
Request
Path Parameters
-
ProfileAssignmentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : hedDataSecurityProfileRoleGroupAssignments-item-response
Type:
Show Source
object
-
BusinessObjectName: string
Read Only:
true
Maximum Length:240
Business object associated with the data security profile. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
dataConditions: array
Data Conditions
Title:
Data Conditions
The data conditions resource is used to create, view, and modify the list of values that define the data condition assigned to a data security profile role group assignee. -
FunctionalAreaMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Functional area of the business object associated with the data security profile. -
GlobalSetFlag: boolean
Title:
Global Set Indicator
Read Only:true
Maximum Length:1
Indicates whether a data security profile is global. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileAssignmentId: integer
(int64)
Unique identifier for the assignee.
-
ProfileDescription: string
Title:
Security Profile Description
Read Only:true
Maximum Length:1000
Description of the data security profile. -
ProfileId: integer
(int64)
Unique identifier for the data security profile.
-
ProfileName: string
Title:
Data Profile Name
Maximum Length:100
Name of the data security profile. -
RoleGroupCode: string
Maximum Length:
50
Alternate unique identifier for the role group. -
RoleGroupDescription: string
Read Only:
true
Maximum Length:4000
Description of the role group. -
RoleGroupId: integer
(int64)
Unique identifier for the role group.
-
RoleGroupName: string
Read Only:
true
Maximum Length:50
Name of the role group.
Nested Schema : Data Conditions
Type:
array
Title:
Data Conditions
The data conditions resource is used to create, view, and modify the list of values that define the data condition assigned to a data security profile role group assignee.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfileRoleGroupAssignments-dataConditions-item-response
Type:
Show Source
object
-
AcademicGroupDisplayValues: string
Title:
Academic Group
Read Only:true
Display values of academic groups assigned to the security condition. -
AcademicGroupIdentifierValues: string
Title:
Academic Group
Unique identifiers for academic groups assigned to the security condition. -
AcademicLevelDisplayValues: string
Title:
Academic Level
Read Only:true
Display values of academic levels assigned to the security condition. -
AcademicLevelIdentifierValues: string
Title:
Academic Level
Unique identifiers for the academic levels assigned to the security condition. -
AcademicOrgDisplayValues: string
Title:
Academic Organization
Read Only:true
Display values of academic organizations assigned to the security condition. -
AcademicOrgIdentifierValues: string
Title:
Academic Organization
Unique identifiers for the academic organizations assigned to the security condition. -
AcademicOrgTreeDisplayValues: string
Title:
Academic Organization Tree
Read Only:true
Display values of academic organization trees assigned to the security condition. -
AcademicOrgTreeIdentifierValues: string
Title:
Academic Organization Tree
Unique identifiers for the academic organization trees assigned to the security condition. -
AcademicPeriodDisplayValues: string
Title:
Academic Period
Read Only:true
Display values of academic periods assigned to the security condition. -
AcademicPeriodIdentifierValues: string
Title:
Academic Period
Unique identifiers for academic periods assigned to the security condition. -
AcademicSubjectDisplayValues: string
Title:
Academic Subject
Read Only:true
Display values of academic subjects assigned to the security condition. -
AcademicSubjectIdentifierValues: string
Title:
Academic Subject
Unique identifiers for academic subjects assigned to the security condition. -
BusinessUnitDisplayValues: string
Title:
Business Unit
Read Only:true
Display values of the business units assigned to the security condition. -
BusinessUnitIdentifierValues: string
Title:
Business Unit
Unique identifiers for the business units assigned to the security condition. -
CampusDisplayValues: string
Title:
Campus
Read Only:true
Display values of campuses assigned to the security condition. -
CampusIdentifierValues: string
Title:
Campus
Unique identifiers for the campuses assigned to the security condition. -
ConditionDetailHash: string
Title:
Condition Hash Value
Maximum Length:64
Hash value for the security condition. -
ConditionId: integer
(int64)
Unique identifier for the security condition.
-
CourseDisplayValues: string
Title:
Course
Read Only:true
Display values of courses assigned to the security condition. -
CourseIdentifierValues: string
Title:
Course
Unique identifiers for courses assigned to the security condition. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: The date and time when the row for the identifier was created. -
dataPrivileges: array
Data Privileges
Title:
Data Privileges
The data privileges resource is used to create, view, and modify the data security privileges for a data condition. -
FieldEightDisplayValues: string
Title:
Field 8
Read Only:true
Display values for Field 8 values assigned to the security condition. -
FieldEightIdentifierValues: string
Title:
Field 8
Unique identifiers for Field 8 values assigned to the security condition. -
FieldFiveDisplayValues: string
Title:
Field 5
Read Only:true
Display values for Field 5 values assigned to the security condition. -
FieldFiveIdentifierValues: string
Title:
Field 5
Unique identifiers for Field 5 values assigned to the security condition. -
FieldFourDisplayValues: string
Title:
Field 4
Read Only:true
Display values for Field 4 values assigned to the security condition. -
FieldFourIdentifierValues: string
Title:
Field 4
Unique identifiers for Field 4 values assigned to the security condition. -
FieldNineDisplayValues: string
Title:
Field 9
Read Only:true
Display values for Field 9 values assigned to the security condition. -
FieldNineIdentifierValues: string
Title:
Field 9
Unique identifiers for Field 9 values assigned to the security condition. -
FieldOneDisplayValues: string
Title:
Field 1
Read Only:true
Display values for Field 1 values assigned to the security condition. -
FieldOneIdentifierValues: string
Title:
Field 1
Unique identifiers for Field 1 values assigned to the security condition. -
FieldSevenDisplayValues: string
Title:
Field 7
Read Only:true
Display values for Field 7 values assigned to the security condition. -
FieldSevenIdentifierValues: string
Title:
Field 7
Unique identifiers for Field 7 values assigned to the security condition. -
FieldSixDisplayValues: string
Title:
Field 6
Read Only:true
Display values for Field 6 values assigned to the security condition. -
FieldSixIdentifierValues: string
Title:
Field 6
Unique identifiers for Field 6 values assigned to the security condition. -
FieldTenDisplayValues: string
Title:
Field 10
Read Only:true
Display values for Field 10 values assigned to the security condition. -
FieldTenIdentifierValues: string
Title:
Field 10
Unique identifiers for Field 10 values assigned to the security condition. -
FieldThreeDisplayValues: string
Title:
Field 3
Read Only:true
Display values for Field 3 values assigned to the security condition. -
FieldThreeIdentifierValues: string
Title:
Field 3
Unique identifiers for Field 3 values assigned to the security condition. -
FieldTwoDisplayValues: string
Title:
Field 2
Read Only:true
Display values for Field 2 values assigned to the security condition. -
FieldTwoIdentifierValues: string
Title:
Field 2
Unique identifiers for Field 2 values assigned to the security condition. -
InstitutionDisplayValues: string
Title:
Institution
Read Only:true
Display values of the institutions assigned to the security condition. -
InstitutionIdentifierValues: string
Title:
Institution
Unique identifiers for the institutions assigned to the security condition. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: The date and time when the row for the identifier was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: The user who last updated the row for the identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonTagDisplayValues: string
Title:
Person Tag
Read Only:true
Display values of person tags assigned to the security condition. -
PersonTagIdentifierValues: string
Title:
Person Tag
Unique identifiers for person tags assigned to the security condition. -
ProgramDisplayValues: string
Title:
Program
Read Only:true
Display values of academic groups assigned to the security condition. -
ProgramIdentifierValues: string
Title:
Program
Unique identifiers for programs assigned to the security condition. -
StorefrontDisplayValues: string
Title:
Storefront
Read Only:true
Display values of storefronts assigned to the security condition. -
StorefrontIdentifierValues: string
Title:
Storefront
Unique identifiers for storefronts assigned to the security condition. -
UserDisplayValues: string
Title:
Users
Read Only:true
Display values of the users assigned to the security condition. -
UserIdentifierValues: string
Title:
Users
Unique identifiers for the users assigned to the security condition.
Nested Schema : Data Privileges
Type:
array
Title:
Data Privileges
The data privileges resource is used to create, view, and modify the data security privileges for a data condition.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfileRoleGroupAssignments-dataConditions-dataPrivileges-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DataPrivilegeId: integer
(int64)
Title:
Data Privilege ID
Unique identifier for the data privilege assigned to the security condition. -
DataPrivilegeName: string
Title:
Data Privilege Name
Read Only:true
Maximum Length:400
Name of the data privilege assigned to the security condition. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrivilegeGrantId: integer
(int64)
Title:
Privilege Grant
Read Only:true
Unique identifier for the data privilege grant.
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.
Links
- dataConditions
-
Parameters:
- ProfileAssignmentId:
$request.path.ProfileAssignmentId
The data conditions resource is used to create, view, and modify the list of values that define the data condition assigned to a data security profile role group assignee. - ProfileAssignmentId:
- hedDataSecurityProfilesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ProfileName; Target Attribute: ProfileName
- Display Attribute: ProfileName
- hedRoleSecurityGroupsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: RoleGroupCode; Target Attribute: GroupCode
- Display Attribute: GroupName