Get a data security profile assignment
get
/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}
Request
Path Parameters
-
ProfileAssignmentId(required): integer(int64)
Unique identifier of the profile assignment.
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 : hedDataSecurityProfileAssignments-item-response
Type:
Show Source
object
-
BusinessObjectName: string
Title:
Business Object
Read Only:true
Maximum Length:240
Name of the business 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. -
dataConditions: array
Data Conditions
Title:
Data Conditions
The data conditions resource provides a list of values that define the data condition assigned to the data security profile assignee (either a role or a user). -
FunctionalAreaMeaning: string
Title:
Functional Area
Read Only:true
Maximum Length:80
Meaning of the functional area of the security profile. -
GlobalSetFlag: boolean
Title:
Global Set Indicator
Read Only:true
Maximum Length:1
Attribute to indicate a global set. -
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. -
PredefinedProfileFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the data profile is predefined. -
ProfileAssignmentId: integer
(int64)
Title:
Profile Assignment ID
Read Only:true
Unique identifier of the profile assignment. -
ProfileDescription: string
Title:
Security Profile Description
Read Only:true
Maximum Length:1000
Description of the security profile. -
ProfileId: integer
(int64)
Title:
Profile ID
Unique identifier of the security profile used for data security. -
ProfileName: string
Title:
Data Profile Name
Maximum Length:100
Name of the security profile. -
RoleCode: string
Title:
Role Code
Maximum Length:256
Attribute to define the role code of the user. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
Attribute to define the role name of the user. -
SeedDataLock: integer
(int32)
Title:
Seed Data Lock
Read Only:true
Default Value:0
Indicates whether the record is predefined. The value 0 means the record is not predefined. The value 1 means the record is predefined and cannot be updated. A value greater than 1 means the record is predefined but can be updated.
Nested Schema : Data Conditions
Type:
array
Title:
Data Conditions
The data conditions resource provides a list of values that define the data condition assigned to the data security profile assignee (either a role or a user).
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfileAssignments-dataConditions-item-response
Type:
Show Source
object
-
AcademicGroupDisplayValues: string
Title:
Academic Group
Read Only:true
Display value of Identifier of the academic group assigned to the field of security condition. -
AcademicGroupIdentifierValues: string
Title:
Academic Group
Identifier of the academic group assigned to the field of the security condition. -
AcademicLevelDisplayValues: string
Title:
Academic Level
Read Only:true
Display value of the academic level assigned to the field on security condition. -
AcademicLevelIdentifierValues: string
Title:
Academic Level
Identifier of the academic level value assigned to the field on security condition. -
AcademicOrgDisplayValues: string
Title:
Academic Organization
Read Only:true
Display value of academic organization assigned to the field of security condition. -
AcademicOrgIdentifierValues: string
Title:
Academic Organization
Identifier of academic organization assigned to the field of security condition. -
AcademicOrgTreeDisplayValues: string
Title:
Academic Organization Tree
Read Only:true
Display value of academic organization tree assigned to the field of security condition. -
AcademicOrgTreeIdentifierValues: string
Title:
Academic Organization Tree
Identifier of an academic organization tree assigned to the field of the security condition. -
AcademicPeriodDisplayValues: string
Title:
Academic Period
Read Only:true
Display value of the academic period assigned to the field on security condition. -
AcademicPeriodIdentifierValues: string
Title:
Academic Period
Identifier of the academic period value assigned to the field for the security condition. -
AcademicSubjectDisplayValues: string
Title:
Academic Subject
Read Only:true
Display value of the academic subject assigned to the field of the security condition. -
AcademicSubjectIdentifierValues: string
Title:
Academic Subject
Identifier of academic subject assigned to the field of security condition. -
BusinessUnitDisplayValues: string
Title:
Business Unit
Read Only:true
Display value of the business unit assigned to the field of security condition. -
BusinessUnitIdentifierValues: string
Title:
Business Unit
Unique identifier for the business unit assigned to the field of the security condition. -
CampusDisplayValues: string
Title:
Campus
Read Only:true
Display value of campus assigned to the field of security condition. -
CampusIdentifierValues: string
Title:
Campus
The unique identifier of the campus assigned to the field of the security condition. -
ConditionDetailHash: string
Title:
Condition Hash Value
Maximum Length:64
Hash value for the security condition. -
ConditionId: integer
(int64)
Title:
Condition Identifier
Read Only:true
Unique identifier of the data condition. -
CourseDisplayValues: string
Title:
Course
Read Only:true
Display value of course assigned to the field on security condition. -
CourseIdentifierValues: string
Title:
Course
Identifier of the course value assigned to the field for the security condition. -
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. -
dataPrivileges: array
Data Privileges
Title:
Data Privileges
The data privileges resource provides a list of data security privileges available to be granted to the data condition assigned for the associated business object. -
FieldEightDisplayValues: string
Title:
Field 8
Read Only:true
Display value of Field 8 for the selected values of a business object field. -
FieldEightIdentifierValues: string
Title:
Field 8
Field 8 value of unique identifiers for the selected values of a business object field. -
FieldFiveDisplayValues: string
Title:
Field 5
Read Only:true
Display value of Field 5 for the selected values of a business object field. -
FieldFiveIdentifierValues: string
Title:
Field 5
Field 5 value of unique identifiers for the selected values of a business object field. -
FieldFourDisplayValues: string
Title:
Field 4
Read Only:true
Display value of Field 4 for the selected values of a business object field. -
FieldFourIdentifierValues: string
Title:
Field 4
Field 4 value of unique identifiers for the selected values of a business object field. -
FieldNineDisplayValues: string
Title:
Field 9
Read Only:true
Display value of Field 9 for the selected values of a business object field. -
FieldNineIdentifierValues: string
Title:
Field 9
Field 9 value of unique identifiers for the selected values of a business object field. -
FieldOneDisplayValues: string
Title:
Field 1
Read Only:true
Display value of Field 1 for the selected values of a business object field. -
FieldOneIdentifierValues: string
Title:
Field 1
Field 1 value of unique identifiers for the selected values of a business object field. -
FieldSevenDisplayValues: string
Title:
Field 7
Read Only:true
Display value of Field 7 for the selected values of a business object field. -
FieldSevenIdentifierValues: string
Title:
Field 7
Field 7 value of unique identifiers for the selected values of a business object field. -
FieldSixDisplayValues: string
Title:
Field 6
Read Only:true
Display value of Field 6 for the selected values of a business object field. -
FieldSixIdentifierValues: string
Title:
Field 6
Field 6 value of unique identifiers for the selected values of a business object field. -
FieldTenDisplayValues: string
Title:
Field 10
Read Only:true
Display value of Field 10 for the selected values of a business object field. -
FieldTenIdentifierValues: string
Title:
Field 10
Field 10 value of unique identifiers for the selected values of a business object field. -
FieldThreeDisplayValues: string
Title:
Field 3
Read Only:true
Display value of Field 3 for the selected values of a business object field. -
FieldThreeIdentifierValues: string
Title:
Field 3
Field 3 value of unique identifiers for the selected values of a business object field. -
FieldTwoDisplayValues: string
Title:
Field 2
Read Only:true
Display value of Field 2 for the selected values of a business object field. -
FieldTwoIdentifierValues: string
Title:
Field 2
Field 2 value of unique identifiers for the selected values of a business object field. -
InstitutionDisplayValues: string
Title:
Institution
Read Only:true
Display value of the institutions assigned to the field of security condition. -
InstitutionIdentifierValues: string
Title:
Institution
Unique identifiers for the selected institutions assigned to the field of 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. -
PersonTagDisplayValues: string
Title:
Person Tag
Read Only:true
Display value of person tag assigned to the field on security condition. -
PersonTagIdentifierValues: string
Title:
Person Tag
Identifier of person tag assigned to the field on security condition. -
ProgramDisplayValues: string
Title:
Program
Read Only:true
Display value of the academic group assigned to the field of security condition. -
ProgramIdentifierValues: string
Title:
Program
Identifier of program value assigned to the field on security condition. -
StorefrontDisplayValues: string
Title:
Storefront
Read Only:true
Display value of storefront assigned to the field on security condition. -
StorefrontIdentifierValues: string
Title:
Storefront
Identifier of storefront value assigned to the field on security condition. -
UserDisplayValues: string
Title:
Users
Read Only:true
Display value of the user assigned to the field of security condition. -
UserIdentifierValues: string
Title:
Users
Unique identifier for the user assigned to the field of the security condition.
Nested Schema : Data Privileges
Type:
array
Title:
Data Privileges
The data privileges resource provides a list of data security privileges available to be granted to the data condition assigned for the associated business object.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfileAssignments-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 of the data privilege created to establish data security. -
DataPrivilegeName: string
Title:
Data Privilege Name
Read Only:true
Maximum Length:400
Attribute to define the data privilege to secure data security. -
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 of the security privileges 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 provides a list of values that define the data condition assigned to the data security profile assignee (either a role or a user). - ProfileAssignmentId:
- hedDataSecurityProfilesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ProfileName; Target Attribute: ProfileName
- Display Attribute: ProfileName
- hedSecurityRolesLOV
-
Parameters:
- finder:
CustomRoleFinder
The following properties are defined on the LOV link relation:- Source Attribute: RoleCode; Target Attribute: RoleCode
- Display Attribute: RoleName
- finder: