Create a data condition grant
post
/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions
Request
Path Parameters
-
ProfileAssignmentId(required): integer(int64)
Unique identifier of the profile assignment.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicGroupIdentifierValues: string
Title:
Academic Group
Identifier of the academic group assigned to the field of the security condition. -
AcademicLevelIdentifierValues: string
Title:
Academic Level
Identifier of the academic level value assigned to the field on security condition. -
AcademicOrgIdentifierValues: string
Title:
Academic Organization
Identifier of academic organization 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. -
AcademicPeriodIdentifierValues: string
Title:
Academic Period
Identifier of the academic period value assigned to the field for the security condition. -
AcademicSubjectIdentifierValues: string
Title:
Academic Subject
Identifier of academic subject 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. -
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. -
CourseIdentifierValues: string
Title:
Course
Identifier of the course value assigned to the field for the security condition. -
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. -
FieldEightIdentifierValues: string
Title:
Field 8
Field 8 value of unique identifiers 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. -
FieldFourIdentifierValues: string
Title:
Field 4
Field 4 value of unique identifiers 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. -
FieldOneIdentifierValues: string
Title:
Field 1
Field 1 value of unique identifiers 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. -
FieldSixIdentifierValues: string
Title:
Field 6
Field 6 value of unique identifiers 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. -
FieldThreeIdentifierValues: string
Title:
Field 3
Field 3 value of unique identifiers 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. -
InstitutionIdentifierValues: string
Title:
Institution
Unique identifiers for the selected institutions assigned to the field of security condition. -
PersonTagIdentifierValues: string
Title:
Person Tag
Identifier of person tag assigned to the field on security condition. -
ProgramIdentifierValues: string
Title:
Program
Identifier of program value assigned to the field on security condition. -
StorefrontIdentifierValues: string
Title:
Storefront
Identifier of storefront value assigned to the field on 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 : hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-post-request
Type:
Show Source
object
-
DataPrivilegeId: integer
(int64)
Title:
Data Privilege ID
Unique identifier of the data privilege created to establish data security.
Response
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-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
- 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: