Jump to

• Request
• Response

Update a data security profile assignment

patch

/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{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=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dataConditions: array Data Conditions
  Title: Data Conditions

  The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.

{
    "type":"object",
    "properties":{
        "dataConditions":{
            "title":"Data Conditions",
            "type":"array",
            "description":"The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-item-patch-request"
            }
        }
    }
}

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 specifies the data condition assigned to a role in a data security profile.

Show Source

• Array of: object schema

{
    "title":"Data Conditions",
    "type":"array",
    "description":"The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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 is used to create, view, and modify the data security privileges for a given data condition.
• 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.

{
    "type":"object",
    "properties":{
        "AcademicGroupIdentifierValues":{
            "title":"Academic Group",
            "type":"string",
            "description":"Identifier of the academic group assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicLevelIdentifierValues"
                ]
            }
        },
        "AcademicLevelIdentifierValues":{
            "title":"Academic Level",
            "type":"string",
            "description":"Identifier of the academic level value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "AcademicOrgIdentifierValues":{
            "title":"Academic Organization",
            "type":"string",
            "description":"Identifier of academic organization assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues",
                    "CampusIdentifierValues"
                ]
            }
        },
        "AcademicOrgTreeIdentifierValues":{
            "title":"Academic Organization Tree",
            "type":"string",
            "description":"Identifier of an academic organization tree assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "AcademicPeriodIdentifierValues":{
            "title":"Academic Period",
            "type":"string",
            "description":"Identifier of the academic period value assigned to the field for the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicSubjectIdentifierValues":{
            "title":"Academic Subject",
            "type":"string",
            "description":"Identifier of academic subject assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicOrgIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "BusinessUnitIdentifierValues":{
            "title":"Business Unit",
            "type":"string",
            "description":"Unique identifier for the business unit assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "CampusIdentifierValues":{
            "title":"Campus",
            "type":"string",
            "description":"The unique identifier of the campus assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "CourseIdentifierValues":{
            "title":"Course",
            "type":"string",
            "description":"Identifier of the course value assigned to the field for the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FieldEightIdentifierValues":{
            "title":"Field 8",
            "type":"string",
            "description":"Field 8 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldFiveIdentifierValues":{
            "title":"Field 5",
            "type":"string",
            "description":"Field 5 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldFourIdentifierValues":{
            "title":"Field 4",
            "type":"string",
            "description":"Field 4 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldNineIdentifierValues":{
            "title":"Field 9",
            "type":"string",
            "description":"Field 9 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldOneIdentifierValues":{
            "title":"Field 1",
            "type":"string",
            "description":"Field 1 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldSevenIdentifierValues":{
            "title":"Field 7",
            "type":"string",
            "description":"Field 7 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldSixIdentifierValues":{
            "title":"Field 6",
            "type":"string",
            "description":"Field 6 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldTenIdentifierValues":{
            "title":"Field 10",
            "type":"string",
            "description":"Field 10 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldThreeIdentifierValues":{
            "title":"Field 3",
            "type":"string",
            "description":"Field 3 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldTwoIdentifierValues":{
            "title":"Field 2",
            "type":"string",
            "description":"Field 2 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "InstitutionIdentifierValues":{
            "title":"Institution",
            "type":"string",
            "description":"Unique identifiers for the selected institutions assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonTagIdentifierValues":{
            "title":"Person Tag",
            "type":"string",
            "description":"Identifier of person tag assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramIdentifierValues":{
            "title":"Program",
            "type":"string",
            "description":"Identifier of program value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicGroupIdentifierValues",
                    "AcademicLevelIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "StorefrontIdentifierValues":{
            "title":"Storefront",
            "type":"string",
            "description":"Identifier of storefront value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserIdentifierValues":{
            "title":"Users",
            "type":"string",
            "description":"Unique identifier for the user assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "dataPrivileges":{
            "title":"Data Privileges",
            "type":"array",
            "description":"The data privileges resource is used to create, view, and modify the data security privileges for a given data condition.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-patch-request"
            }
        }
    }
}

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 given data condition.

Show Source

• Array of: object schema

{
    "title":"Data Privileges",
    "type":"array",
    "description":"The data privileges resource is used to create, view, and modify the data security privileges for a given data condition.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

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.

Body ()

Root Schema : hedDataSecurityProfileAssignments-item-response

Type: object

Show Source

• 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 is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.
• 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
  Title: Predefined Data Profile Indicator

  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 isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.

{
    "type":"object",
    "properties":{
        "BusinessObjectName":{
            "title":"Business Object",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"An attribute to store the user name of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalAreaMeaning":{
            "title":"Functional Area",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the functional area of the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GlobalSetFlag":{
            "title":"Global Set Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute to indicate a global set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User name of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PredefinedProfileFlag":{
            "title":"Predefined Data Profile Indicator",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the data profile is predefined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileAssignmentId":{
            "title":"Profile Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the profile assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProfileDescription":{
            "title":"Security Profile Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileId":{
            "title":"Profile ID",
            "type":"integer",
            "description":"Unique identifier of the security profile used for data security.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileName":{
            "title":"Data Profile Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the security profile.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":256,
            "type":"string",
            "description":"Attribute to define the role code of the user.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":240,
            "type":"string",
            "description":"Attribute to define the role name of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Seed Data Lock",
            "type":"integer",
            "description":"Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "dataConditions":{
            "title":"Data Conditions",
            "type":"array",
            "description":"The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 specifies the data condition assigned to a role in a data security profile.

Show Source

• Array of: object hedDataSecurityProfileAssignments-dataConditions-item-response

{
    "title":"Data Conditions",
    "type":"array",
    "description":"The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedDataSecurityProfileAssignments-dataConditions-item-response

Type: object

Show Source

• 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

  Read Only: true

  Maximum Length: 255

  Hash value for the security condition.
• ConditionId: integer (int64)
  Title: Condition Identifier

  Read Only: true

  Unique identifier for the security 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 is used to create, view, and modify the data security privileges for a given data condition.
• 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 program assigned to the field of the 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.

{
    "type":"object",
    "properties":{
        "AcademicGroupDisplayValues":{
            "title":"Academic Group",
            "type":"string",
            "description":"Display value of Identifier of the academic group assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupIdentifierValues":{
            "title":"Academic Group",
            "type":"string",
            "description":"Identifier of the academic group assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicLevelIdentifierValues"
                ]
            }
        },
        "AcademicLevelDisplayValues":{
            "title":"Academic Level",
            "type":"string",
            "description":"Display value of the academic level assigned to the field on security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelIdentifierValues":{
            "title":"Academic Level",
            "type":"string",
            "description":"Identifier of the academic level value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "AcademicOrgDisplayValues":{
            "title":"Academic Organization",
            "type":"string",
            "description":"Display value of academic organization assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgIdentifierValues":{
            "title":"Academic Organization",
            "type":"string",
            "description":"Identifier of academic organization assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues",
                    "CampusIdentifierValues"
                ]
            }
        },
        "AcademicOrgTreeDisplayValues":{
            "title":"Academic Organization Tree",
            "type":"string",
            "description":"Display value of academic organization tree assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgTreeIdentifierValues":{
            "title":"Academic Organization Tree",
            "type":"string",
            "description":"Identifier of an academic organization tree assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "AcademicPeriodDisplayValues":{
            "title":"Academic Period",
            "type":"string",
            "description":"Display value of the academic period assigned to the field on security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodIdentifierValues":{
            "title":"Academic Period",
            "type":"string",
            "description":"Identifier of the academic period value assigned to the field for the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicSubjectDisplayValues":{
            "title":"Academic Subject",
            "type":"string",
            "description":"Display value of the academic subject assigned to the field of the security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectIdentifierValues":{
            "title":"Academic Subject",
            "type":"string",
            "description":"Identifier of academic subject assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicOrgIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "BusinessUnitDisplayValues":{
            "title":"Business Unit",
            "type":"string",
            "description":"Display value of the business unit assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitIdentifierValues":{
            "title":"Business Unit",
            "type":"string",
            "description":"Unique identifier for the business unit assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "CampusDisplayValues":{
            "title":"Campus",
            "type":"string",
            "description":"Display value of campus assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusIdentifierValues":{
            "title":"Campus",
            "type":"string",
            "description":"The unique identifier of the campus assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "ConditionDetailHash":{
            "title":"Condition Hash Value",
            "maxLength":255,
            "type":"string",
            "description":"Hash value for the security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionId":{
            "title":"Condition Identifier",
            "type":"integer",
            "description":"Unique identifier for the security condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CourseDisplayValues":{
            "title":"Course",
            "type":"string",
            "description":"Display value of course assigned to the field on security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseIdentifierValues":{
            "title":"Course",
            "type":"string",
            "description":"Identifier of the course value assigned to the field for the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"An attribute to store the user name of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldEightDisplayValues":{
            "title":"Field 8",
            "type":"string",
            "description":"Display value of Field 8 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldEightIdentifierValues":{
            "title":"Field 8",
            "type":"string",
            "description":"Field 8 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldFiveDisplayValues":{
            "title":"Field 5",
            "type":"string",
            "description":"Display value of Field 5 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldFiveIdentifierValues":{
            "title":"Field 5",
            "type":"string",
            "description":"Field 5 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldFourDisplayValues":{
            "title":"Field 4",
            "type":"string",
            "description":"Display value of Field 4 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldFourIdentifierValues":{
            "title":"Field 4",
            "type":"string",
            "description":"Field 4 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldNineDisplayValues":{
            "title":"Field 9",
            "type":"string",
            "description":"Display value of Field 9 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldNineIdentifierValues":{
            "title":"Field 9",
            "type":"string",
            "description":"Field 9 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldOneDisplayValues":{
            "title":"Field 1",
            "type":"string",
            "description":"Display value of Field 1 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldOneIdentifierValues":{
            "title":"Field 1",
            "type":"string",
            "description":"Field 1 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldSevenDisplayValues":{
            "title":"Field 7",
            "type":"string",
            "description":"Display value of Field 7 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldSevenIdentifierValues":{
            "title":"Field 7",
            "type":"string",
            "description":"Field 7 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldSixDisplayValues":{
            "title":"Field 6",
            "type":"string",
            "description":"Display value of Field 6 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldSixIdentifierValues":{
            "title":"Field 6",
            "type":"string",
            "description":"Field 6 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldTenDisplayValues":{
            "title":"Field 10",
            "type":"string",
            "description":"Display value of Field 10 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldTenIdentifierValues":{
            "title":"Field 10",
            "type":"string",
            "description":"Field 10 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldThreeDisplayValues":{
            "title":"Field 3",
            "type":"string",
            "description":"Display value of Field 3 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldThreeIdentifierValues":{
            "title":"Field 3",
            "type":"string",
            "description":"Field 3 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldTwoDisplayValues":{
            "title":"Field 2",
            "type":"string",
            "description":"Display value of Field 2 for the selected values of a business object field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldTwoIdentifierValues":{
            "title":"Field 2",
            "type":"string",
            "description":"Field 2 value of unique identifiers for the selected values of a business object field.",
            "nullable":true,
            "x-queryable":false
        },
        "InstitutionDisplayValues":{
            "title":"Institution",
            "type":"string",
            "description":"Display value of the institutions assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionIdentifierValues":{
            "title":"Institution",
            "type":"string",
            "description":"Unique identifiers for the selected institutions assigned to the field of security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User name of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTagDisplayValues":{
            "title":"Person Tag",
            "type":"string",
            "description":"Display value of person tag assigned to the field on security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTagIdentifierValues":{
            "title":"Person Tag",
            "type":"string",
            "description":"Identifier of person tag assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramDisplayValues":{
            "title":"Program",
            "type":"string",
            "description":"Display value of program assigned to the field of the security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramIdentifierValues":{
            "title":"Program",
            "type":"string",
            "description":"Identifier of program value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicGroupIdentifierValues",
                    "AcademicLevelIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "StorefrontDisplayValues":{
            "title":"Storefront",
            "type":"string",
            "description":"Display value of storefront assigned to the field on security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StorefrontIdentifierValues":{
            "title":"Storefront",
            "type":"string",
            "description":"Identifier of storefront value assigned to the field on security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserDisplayValues":{
            "title":"Users",
            "type":"string",
            "description":"Display value of the user assigned to the field of security condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserIdentifierValues":{
            "title":"Users",
            "type":"string",
            "description":"Unique identifier for the user assigned to the field of the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "dataPrivileges":{
            "title":"Data Privileges",
            "type":"array",
            "description":"The data privileges resource is used to create, view, and modify the data security privileges for a given data condition.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 given data condition.

Show Source

• Array of: object hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-response

{
    "title":"Data Privileges",
    "type":"array",
    "description":"The data privileges resource is used to create, view, and modify the data security privileges for a given data condition.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedDataSecurityProfileAssignments-dataConditions-dataPrivileges-item-response

Type: object

Show Source

• 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

  Name of the data privilege created to establish 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"An attribute to store the user name of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataPrivilegeId":{
            "title":"Data Privilege ID",
            "type":"integer",
            "description":"Unique identifier of the data privilege created to establish data security.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataPrivilegeName":{
            "title":"Data Privilege Name",
            "maxLength":400,
            "type":"string",
            "description":"Name of the data privilege created to establish data security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User name of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivilegeGrantId":{
            "title":"Privilege Grant",
            "type":"integer",
            "description":"Unique identifier of the security privileges grant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

dataConditions

Operation: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileAssignments/{ProfileAssignmentId}/child/dataConditions

Parameters:

• ProfileAssignmentId: $request.path.ProfileAssignmentId

The data conditions resource is used to create, view, and modify the list of values that specifies the data condition assigned to a role in a data security profile.

hedDataSecurityProfilesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles

The following properties are defined on the LOV link relation:

• Source Attribute: ProfileName; Target Attribute: ProfileName
• Display Attribute: ProfileName

hedSecurityRolesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedSecurityRoles

Parameters:

• finder: CustomRoleFinder

The following properties are defined on the LOV link relation:

• Source Attribute: RoleCode; Target Attribute: RoleCode
• Display Attribute: RoleName

Back to Top