Get a data condition grant
get
/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}
Request
Path Parameters
-
ConditionId(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=
-
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:
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.
Root Schema : hedDataSecurityProfileAssignments-dataConditions-item-response
Type:
Show Source
object-
AcademicGroupDisplayValues: string
Title:
Academic GroupRead Only:trueDisplay value of Identifier of the academic group assigned to the field of security condition. -
AcademicGroupIdentifierValues: string
Title:
Academic GroupIdentifier of the academic group assigned to the field of the security condition. -
AcademicLevelDisplayValues: string
Title:
Academic LevelRead Only:trueDisplay value of the academic level assigned to the field on security condition. -
AcademicLevelIdentifierValues: string
Title:
Academic LevelIdentifier of the academic level value assigned to the field on security condition. -
AcademicOrgDisplayValues: string
Title:
Academic OrganizationRead Only:trueDisplay value of academic organization assigned to the field of security condition. -
AcademicOrgIdentifierValues: string
Title:
Academic OrganizationIdentifier of academic organization assigned to the field of security condition. -
AcademicOrgTreeDisplayValues: string
Title:
Academic Organization TreeRead Only:trueDisplay value of academic organization tree assigned to the field of security condition. -
AcademicOrgTreeIdentifierValues: string
Title:
Academic Organization TreeIdentifier of an academic organization tree assigned to the field of the security condition. -
AcademicPeriodDisplayValues: string
Title:
Academic PeriodRead Only:trueDisplay value of the academic period assigned to the field on security condition. -
AcademicPeriodIdentifierValues: string
Title:
Academic PeriodIdentifier of the academic period value assigned to the field for the security condition. -
AcademicSubjectDisplayValues: string
Title:
Academic SubjectRead Only:trueDisplay value of the academic subject assigned to the field of the security condition. -
AcademicSubjectIdentifierValues: string
Title:
Academic SubjectIdentifier of academic subject assigned to the field of security condition. -
BusinessUnitDisplayValues: string
Title:
Business UnitRead Only:trueDisplay value of the business unit assigned to the field of security condition. -
BusinessUnitIdentifierValues: string
Title:
Business UnitUnique identifier for the business unit assigned to the field of the security condition. -
CampusDisplayValues: string
Title:
CampusRead Only:trueDisplay value of campus assigned to the field of security condition. -
CampusIdentifierValues: string
Title:
CampusThe unique identifier of the campus assigned to the field of the security condition. -
ConditionDetailHash: string
Title:
Condition Hash ValueMaximum Length:64Hash value for the security condition. -
ConditionId: integer
(int64)
Title:
Condition IdentifierRead Only:trueUnique identifier for the security condition. -
CourseDisplayValues: string
Title:
CourseRead Only:trueDisplay value of course assigned to the field on security condition. -
CourseIdentifierValues: string
Title:
CourseIdentifier of the course value assigned to the field for the security condition. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
dataPrivileges: array
Data Privileges
Title:
Data PrivilegesThe 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 8Read Only:trueDisplay value of Field 8 for the selected values of a business object field. -
FieldEightIdentifierValues: string
Title:
Field 8Field 8 value of unique identifiers for the selected values of a business object field. -
FieldFiveDisplayValues: string
Title:
Field 5Read Only:trueDisplay value of Field 5 for the selected values of a business object field. -
FieldFiveIdentifierValues: string
Title:
Field 5Field 5 value of unique identifiers for the selected values of a business object field. -
FieldFourDisplayValues: string
Title:
Field 4Read Only:trueDisplay value of Field 4 for the selected values of a business object field. -
FieldFourIdentifierValues: string
Title:
Field 4Field 4 value of unique identifiers for the selected values of a business object field. -
FieldNineDisplayValues: string
Title:
Field 9Read Only:trueDisplay value of Field 9 for the selected values of a business object field. -
FieldNineIdentifierValues: string
Title:
Field 9Field 9 value of unique identifiers for the selected values of a business object field. -
FieldOneDisplayValues: string
Title:
Field 1Read Only:trueDisplay value of Field 1 for the selected values of a business object field. -
FieldOneIdentifierValues: string
Title:
Field 1Field 1 value of unique identifiers for the selected values of a business object field. -
FieldSevenDisplayValues: string
Title:
Field 7Read Only:trueDisplay value of Field 7 for the selected values of a business object field. -
FieldSevenIdentifierValues: string
Title:
Field 7Field 7 value of unique identifiers for the selected values of a business object field. -
FieldSixDisplayValues: string
Title:
Field 6Read Only:trueDisplay value of Field 6 for the selected values of a business object field. -
FieldSixIdentifierValues: string
Title:
Field 6Field 6 value of unique identifiers for the selected values of a business object field. -
FieldTenDisplayValues: string
Title:
Field 10Read Only:trueDisplay value of Field 10 for the selected values of a business object field. -
FieldTenIdentifierValues: string
Title:
Field 10Field 10 value of unique identifiers for the selected values of a business object field. -
FieldThreeDisplayValues: string
Title:
Field 3Read Only:trueDisplay value of Field 3 for the selected values of a business object field. -
FieldThreeIdentifierValues: string
Title:
Field 3Field 3 value of unique identifiers for the selected values of a business object field. -
FieldTwoDisplayValues: string
Title:
Field 2Read Only:trueDisplay value of Field 2 for the selected values of a business object field. -
FieldTwoIdentifierValues: string
Title:
Field 2Field 2 value of unique identifiers for the selected values of a business object field. -
InstitutionDisplayValues: string
Title:
InstitutionRead Only:trueDisplay value of the institutions assigned to the field of security condition. -
InstitutionIdentifierValues: string
Title:
InstitutionUnique identifiers for the selected institutions assigned to the field of security condition. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User name of the person who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonTagDisplayValues: string
Title:
Person TagRead Only:trueDisplay value of person tag assigned to the field on security condition. -
PersonTagIdentifierValues: string
Title:
Person TagIdentifier of person tag assigned to the field on security condition. -
ProgramDisplayValues: string
Title:
ProgramRead Only:trueDisplay value of the academic group assigned to the field of security condition. -
ProgramIdentifierValues: string
Title:
ProgramIdentifier of program value assigned to the field on security condition. -
StorefrontDisplayValues: string
Title:
StorefrontRead Only:trueDisplay value of storefront assigned to the field on security condition. -
StorefrontIdentifierValues: string
Title:
StorefrontIdentifier of storefront value assigned to the field on security condition. -
UserDisplayValues: string
Title:
UsersRead Only:trueDisplay value of the user assigned to the field of security condition. -
UserIdentifierValues: string
Title:
UsersUnique identifier for the user assigned to the field of the security condition.
Nested Schema : Data Privileges
Type:
arrayTitle:
Data PrivilegesThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DataPrivilegeId: integer
(int64)
Title:
Data Privilege IDUnique identifier of the data privilege created to establish data security. -
DataPrivilegeName: string
Title:
Data Privilege NameRead Only:trueMaximum Length:400Attribute to define the data privilege to secure data security. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User name of the person who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrivilegeGrantId: integer
(int64)
Title:
Privilege GrantRead Only:trueUnique identifier of the security privileges grant.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- academicGroupsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicGroupIdentifierValues; Target Attribute: AcademicGroupId
- Display Attribute: CurriculumName
- academicInstitutionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionIdentifierValues; Target Attribute: InstitutionId
- Display Attribute: InstitutionName, Description
- academicLevelsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicLevelIdentifierValues; Target Attribute: AcademicLevelId
- Display Attribute: LevelName, Description
- academicOrganizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicOrgIdentifierValues; Target Attribute: AcademicOrgId
- Display Attribute: AcademicOrgName, Description
- academicPeriodsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicPeriodIdentifierValues; Target Attribute: AcademicPeriodId
- Display Attribute: PeriodName
- campusesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CampusIdentifierValues; Target Attribute: CampusId
- Display Attribute: CampusName, Description
- coursesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CourseIdentifierValues; Target Attribute: CurriculumId
- Display Attribute: CurriculumName, CurriculumLongDescription
- dataPrivileges
-
Parameters:
- ConditionId:
$request.path.ConditionId - ProfileAssignmentId:
$request.path.ProfileAssignmentId
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. - ConditionId:
- programsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ProgramIdentifierValues; Target Attribute: CurriculumId
- Display Attribute: CurriculumName, CurriculumLongDescription
- storefrontsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: StorefrontIdentifierValues; Target Attribute: StorefrontId
- Display Attribute: StorefrontName, Description
- subjectsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicSubjectIdentifierValues; Target Attribute: AcademicSubjectId
- Display Attribute: AcademicSubjectName, Description
- userAccountsLOV
-
Parameters:
- finder:
ByRoleAndKeywordFinder%3BRoleCode%3D{RoleCode}
The following properties are defined on the LOV link relation:- Source Attribute: UserIdentifierValues; Target Attribute: UserGUID
- Display Attribute: UserName
- finder: