Jump to

• Request
• Response

Create a data condition

post

/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions

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:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicGroupIdentifierValues: string
  Title: Academic Group

  Unique identifiers for academic groups assigned to the security condition.
• AcademicLevelIdentifierValues: string
  Title: Academic Level

  Unique identifiers for the academic levels assigned to the security condition.
• AcademicOrgIdentifierValues: string
  Title: Academic Organization

  Unique identifiers for the academic organizations assigned to the security condition.
• AcademicOrgTreeIdentifierValues: string
  Title: Academic Organization Tree

  Unique identifiers for the academic organization trees assigned to the security condition.
• AcademicPeriodIdentifierValues: string
  Title: Academic Period

  Unique identifiers for academic periods assigned to the security condition.
• AcademicSubjectIdentifierValues: string
  Title: Academic Subject

  Unique identifiers for academic subjects assigned to the security condition.
• BusinessUnitIdentifierValues: string
  Title: Business Unit

  Unique identifiers for the business units assigned to the security condition.
• CampusIdentifierValues: string
  Title: Campus

  Unique identifiers for the campuses assigned to the security condition.
• ConditionDetailHash(required): string
  Title: Condition Hash Value

  Maximum Length: 64

  Hash value for the security condition.
• ConditionId: integer (int64)
  Unique identifier for the security condition.
• CourseIdentifierValues: string
  Title: Course

  Unique identifiers for courses assigned to 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 data condition.
• FieldEightIdentifierValues: string
  Title: Field 8

  Unique identifiers for Field 8 values assigned to the security condition.
• FieldFiveIdentifierValues: string
  Title: Field 5

  Unique identifiers for Field 5 values assigned to the security condition.
• FieldFourIdentifierValues: string
  Title: Field 4

  Unique identifiers for Field 4 values assigned to the security condition.
• FieldNineIdentifierValues: string
  Title: Field 9

  Unique identifiers for Field 9 values assigned to the security condition.
• FieldOneIdentifierValues: string
  Title: Field 1

  Unique identifiers for Field 1 values assigned to the security condition.
• FieldSevenIdentifierValues: string
  Title: Field 7

  Unique identifiers for Field 7 values assigned to the security condition.
• FieldSixIdentifierValues: string
  Title: Field 6

  Unique identifiers for Field 6 values assigned to the security condition.
• FieldTenIdentifierValues: string
  Title: Field 10

  Unique identifiers for Field 10 values assigned to the security condition.
• FieldThreeIdentifierValues: string
  Title: Field 3

  Unique identifiers for Field 3 values assigned to the security condition.
• FieldTwoIdentifierValues: string
  Title: Field 2

  Unique identifiers for Field 2 values assigned to the security condition.
• InstitutionIdentifierValues: string
  Title: Institution

  Unique identifiers for the institutions assigned to the security condition.
• PersonTagIdentifierValues: string
  Title: Person Tag

  Unique identifiers for person tags assigned to the security condition.
• ProgramIdentifierValues: string
  Title: Program

  Unique identifiers for programs assigned to the security condition.
• StorefrontIdentifierValues: string
  Title: Storefront

  Unique identifiers for storefronts assigned to the security condition.
• UserIdentifierValues: string
  Title: Users

  Unique identifiers for the users assigned to the security condition.

{
    "required":[
        "ConditionDetailHash"
    ],
    "type":"object",
    "properties":{
        "AcademicLevelIdentifierValues":{
            "title":"Academic Level",
            "type":"string",
            "description":"Unique identifiers for the academic levels assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "FieldFourIdentifierValues":{
            "title":"Field 4",
            "type":"string",
            "description":"Unique identifiers for Field 4 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "AcademicPeriodIdentifierValues":{
            "title":"Academic Period",
            "type":"string",
            "description":"Unique identifiers for academic periods assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnitIdentifierValues":{
            "title":"Business Unit",
            "type":"string",
            "description":"Unique identifiers for the business units assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldOneIdentifierValues":{
            "title":"Field 1",
            "type":"string",
            "description":"Unique identifiers for Field 1 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionDetailHash":{
            "title":"Condition Hash Value",
            "maxLength":"64",
            "type":"string",
            "description":"Hash value for the security condition.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "dataPrivileges":{
            "title":"Data Privileges",
            "type":"array",
            "description":"The data privileges resource is used to create, view, and modify the data security privileges for a data condition.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfileRoleGroupAssignments-dataConditions-dataPrivileges-item-post-request"
            }
        },
        "CampusIdentifierValues":{
            "title":"Campus",
            "type":"string",
            "description":"Unique identifiers for the campuses assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "FieldTwoIdentifierValues":{
            "title":"Field 2",
            "type":"string",
            "description":"Unique identifiers for Field 2 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonTagIdentifierValues":{
            "title":"Person Tag",
            "type":"string",
            "description":"Unique identifiers for person tags assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "AcademicOrgTreeIdentifierValues":{
            "title":"Academic Organization Tree",
            "type":"string",
            "description":"Unique identifiers for the academic organization trees assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "ConditionId":{
            "type":"integer",
            "description":"Unique identifier for the security condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StorefrontIdentifierValues":{
            "title":"Storefront",
            "type":"string",
            "description":"Unique identifiers for storefronts assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CourseIdentifierValues":{
            "title":"Course",
            "type":"string",
            "description":"Unique identifiers for courses assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicGroupIdentifierValues":{
            "title":"Academic Group",
            "type":"string",
            "description":"Unique identifiers for academic groups assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicLevelIdentifierValues"
                ]
            }
        },
        "FieldThreeIdentifierValues":{
            "title":"Field 3",
            "type":"string",
            "description":"Unique identifiers for Field 3 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "UserIdentifierValues":{
            "title":"Users",
            "type":"string",
            "description":"Unique identifiers for the users assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FieldFiveIdentifierValues":{
            "title":"Field 5",
            "type":"string",
            "description":"Unique identifiers for Field 5 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldNineIdentifierValues":{
            "title":"Field 9",
            "type":"string",
            "description":"Unique identifiers for Field 9 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldEightIdentifierValues":{
            "title":"Field 8",
            "type":"string",
            "description":"Unique identifiers for Field 8 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "AcademicOrgIdentifierValues":{
            "title":"Academic Organization",
            "type":"string",
            "description":"Unique identifiers for the academic organizations assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionIdentifierValues",
                    "CampusIdentifierValues"
                ]
            }
        },
        "AcademicSubjectIdentifierValues":{
            "title":"Academic Subject",
            "type":"string",
            "description":"Unique identifiers for academic subjects assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicOrgIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "FieldSixIdentifierValues":{
            "title":"Field 6",
            "type":"string",
            "description":"Unique identifiers for Field 6 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldTenIdentifierValues":{
            "title":"Field 10",
            "type":"string",
            "description":"Unique identifiers for Field 10 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldSevenIdentifierValues":{
            "title":"Field 7",
            "type":"string",
            "description":"Unique identifiers for Field 7 values assigned to the security condition.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramIdentifierValues":{
            "title":"Program",
            "type":"string",
            "description":"Unique identifiers for programs assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AcademicGroupIdentifierValues",
                    "AcademicLevelIdentifierValues",
                    "InstitutionIdentifierValues"
                ]
            }
        },
        "InstitutionIdentifierValues":{
            "title":"Institution",
            "type":"string",
            "description":"Unique identifiers for the institutions assigned to the security condition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Data Privileges

Type: array

Title: Data Privileges

The data privileges resource is used to create, view, and modify the data security privileges for a data condition.

Show Source

• 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 data condition.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileRoleGroupAssignments-dataConditions-dataPrivileges-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DataPrivilegeId: integer (int64)
  Title: Data Privilege ID

  Unique identifier for the data privilege assigned to the security condition.

{
    "type":"object",
    "properties":{
        "DataPrivilegeId":{
            "title":"Data Privilege ID",
            "type":"integer",
            "description":"Unique identifier for the data privilege assigned to the security condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : hedDataSecurityProfileRoleGroupAssignments-dataConditions-item-response

Type: object

Show Source

• AcademicGroupDisplayValues: string
  Title: Academic Group

  Read Only: true

  Display values of academic groups assigned to the security condition.
• AcademicGroupIdentifierValues: string
  Title: Academic Group

  Unique identifiers for academic groups assigned to the security condition.
• AcademicLevelDisplayValues: string
  Title: Academic Level

  Read Only: true

  Display values of academic levels assigned to the security condition.
• AcademicLevelIdentifierValues: string
  Title: Academic Level

  Unique identifiers for the academic levels assigned to the security condition.
• AcademicOrgDisplayValues: string
  Title: Academic Organization

  Read Only: true

  Display values of academic organizations assigned to the security condition.
• AcademicOrgIdentifierValues: string
  Title: Academic Organization

  Unique identifiers for the academic organizations assigned to the security condition.
• AcademicOrgTreeDisplayValues: string
  Title: Academic Organization Tree

  Read Only: true

  Display values of academic organization trees assigned to the security condition.
• AcademicOrgTreeIdentifierValues: string
  Title: Academic Organization Tree

  Unique identifiers for the academic organization trees assigned to the security condition.
• AcademicPeriodDisplayValues: string
  Title: Academic Period

  Read Only: true

  Display values of academic periods assigned to the security condition.
• AcademicPeriodIdentifierValues: string
  Title: Academic Period

  Unique identifiers for academic periods assigned to the security condition.
• AcademicSubjectDisplayValues: string
  Title: Academic Subject

  Read Only: true

  Display values of academic subjects assigned to the security condition.
• AcademicSubjectIdentifierValues: string
  Title: Academic Subject

  Unique identifiers for academic subjects assigned to the security condition.
• BusinessUnitDisplayValues: string
  Title: Business Unit

  Read Only: true

  Display values of the business units assigned to the security condition.
• BusinessUnitIdentifierValues: string
  Title: Business Unit

  Unique identifiers for the business units assigned to the security condition.
• CampusDisplayValues: string
  Title: Campus

  Read Only: true

  Display values of campuses assigned to the security condition.
• CampusIdentifierValues: string
  Title: Campus

  Unique identifiers for the campuses assigned to the security condition.
• ConditionDetailHash: string
  Title: Condition Hash Value

  Maximum Length: 64

  Hash value for the security condition.
• ConditionId: integer (int64)
  Unique identifier for the security condition.
• CourseDisplayValues: string
  Title: Course

  Read Only: true

  Display values of courses assigned to the security condition.
• CourseIdentifierValues: string
  Title: Course

  Unique identifiers for courses assigned to the security condition.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: The user who first created the row for the identifier.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: The date and time when the row for the identifier was created.
• dataPrivileges: array Data Privileges
  Title: Data Privileges

  The data privileges resource is used to create, view, and modify the data security privileges for a data condition.
• FieldEightDisplayValues: string
  Title: Field 8

  Read Only: true

  Display values for Field 8 values assigned to the security condition.
• FieldEightIdentifierValues: string
  Title: Field 8

  Unique identifiers for Field 8 values assigned to the security condition.
• FieldFiveDisplayValues: string
  Title: Field 5

  Read Only: true

  Display values for Field 5 values assigned to the security condition.
• FieldFiveIdentifierValues: string
  Title: Field 5

  Unique identifiers for Field 5 values assigned to the security condition.
• FieldFourDisplayValues: string
  Title: Field 4

  Read Only: true

  Display values for Field 4 values assigned to the security condition.
• FieldFourIdentifierValues: string
  Title: Field 4

  Unique identifiers for Field 4 values assigned to the security condition.
• FieldNineDisplayValues: string
  Title: Field 9

  Read Only: true

  Display values for Field 9 values assigned to the security condition.
• FieldNineIdentifierValues: string
  Title: Field 9

  Unique identifiers for Field 9 values assigned to the security condition.
• FieldOneDisplayValues: string
  Title: Field 1

  Read Only: true

  Display values for Field 1 values assigned to the security condition.
• FieldOneIdentifierValues: string
  Title: Field 1

  Unique identifiers for Field 1 values assigned to the security condition.
• FieldSevenDisplayValues: string
  Title: Field 7

  Read Only: true

  Display values for Field 7 values assigned to the security condition.
• FieldSevenIdentifierValues: string
  Title: Field 7

  Unique identifiers for Field 7 values assigned to the security condition.
• FieldSixDisplayValues: string
  Title: Field 6

  Read Only: true

  Display values for Field 6 values assigned to the security condition.
• FieldSixIdentifierValues: string
  Title: Field 6

  Unique identifiers for Field 6 values assigned to the security condition.
• FieldTenDisplayValues: string
  Title: Field 10

  Read Only: true

  Display values for Field 10 values assigned to the security condition.
• FieldTenIdentifierValues: string
  Title: Field 10

  Unique identifiers for Field 10 values assigned to the security condition.
• FieldThreeDisplayValues: string
  Title: Field 3

  Read Only: true

  Display values for Field 3 values assigned to the security condition.
• FieldThreeIdentifierValues: string
  Title: Field 3

  Unique identifiers for Field 3 values assigned to the security condition.
• FieldTwoDisplayValues: string
  Title: Field 2

  Read Only: true

  Display values for Field 2 values assigned to the security condition.
• FieldTwoIdentifierValues: string
  Title: Field 2

  Unique identifiers for Field 2 values assigned to the security condition.
• InstitutionDisplayValues: string
  Title: Institution

  Read Only: true

  Display values of the institutions assigned to the security condition.
• InstitutionIdentifierValues: string
  Title: Institution

  Unique identifiers for the institutions assigned to the security condition.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: The user who last updated the row for the identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonTagDisplayValues: string
  Title: Person Tag

  Read Only: true

  Display values of person tags assigned to the security condition.
• PersonTagIdentifierValues: string
  Title: Person Tag

  Unique identifiers for person tags assigned to the security condition.
• ProgramDisplayValues: string
  Title: Program

  Read Only: true

  Display values of academic groups assigned to the security condition.
• ProgramIdentifierValues: string
  Title: Program

  Unique identifiers for programs assigned to the security condition.
• StorefrontDisplayValues: string
  Title: Storefront

  Read Only: true

  Display values of storefronts assigned to the security condition.
• StorefrontIdentifierValues: string
  Title: Storefront

  Unique identifiers for storefronts assigned to the security condition.
• UserDisplayValues: string
  Title: Users

  Read Only: true

  Display values of the users assigned to the security condition.
• UserIdentifierValues: string
  Title: Users

  Unique identifiers for the users assigned to the security condition.

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

Nested Schema : Data Privileges

Type: array

Title: Data Privileges

The data privileges resource is used to create, view, and modify the data security privileges for a data condition.

Show Source

• Array of: object hedDataSecurityProfileRoleGroupAssignments-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 data condition.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfileRoleGroupAssignments-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 : hedDataSecurityProfileRoleGroupAssignments-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 for the data privilege assigned to the security condition.
• DataPrivilegeName: string
  Title: Data Privilege Name

  Read Only: true

  Maximum Length: 400

  Name of the data privilege assigned to the security condition.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User name of the person who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrivilegeGrantId: integer (int64)
  Title: Privilege Grant

  Read Only: true

  Unique identifier for the data privilege grant.

{
    "type":"object",
    "properties":{
        "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 for the data privilege grant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "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
        },
        "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
        },
        "DataPrivilegeId":{
            "title":"Data Privilege ID",
            "type":"integer",
            "description":"Unique identifier for the data privilege assigned to the security condition.",
            "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 assigned to the security condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

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

academicGroupsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicGroupsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicGroupIdentifierValues; Target Attribute: AcademicGroupId
• Display Attribute: CurriculumName

academicInstitutionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionIdentifierValues; Target Attribute: InstitutionId
• Display Attribute: InstitutionName, Description

academicLevelsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicLevelsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicLevelIdentifierValues; Target Attribute: AcademicLevelId
• Display Attribute: LevelName

academicOrganizationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicOrganizationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicOrgIdentifierValues; Target Attribute: AcademicOrgId
• Display Attribute: AcademicOrgName

academicPeriodsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicPeriodsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicPeriodIdentifierValues; Target Attribute: AcademicPeriodId
• Display Attribute: PeriodName

campusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/campusesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CampusIdentifierValues; Target Attribute: CampusId
• Display Attribute: CampusName, Description

coursesLOV

Operation: /fscmRestApi/resources/11.13.18.05/coursesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CourseIdentifierValues; Target Attribute: CurriculumId
• Display Attribute: CurriculumName

dataPrivileges

Operation: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfileRoleGroupAssignments/{ProfileAssignmentId}/child/dataConditions/{ConditionId}/child/dataPrivileges

Parameters:

• ConditionId: $request.path.ConditionId
• ProfileAssignmentId: $request.path.ProfileAssignmentId

The data privileges resource is used to create, view, and modify the data security privileges for a data condition.

hedUserAccounts

Operation: /fscmRestApi/resources/11.13.18.05/hedUserAccounts

Parameters:

• finder: ByRoleGroupAndKeywordFinder%3BRoleGroupCode%3D{RoleGroupCode}

The following properties are defined on the LOV link relation:

• Source Attribute: UserIdentifierValues; Target Attribute: UserGUID
• Display Attribute: UserName

programsLOV

Operation: /fscmRestApi/resources/11.13.18.05/programsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramIdentifierValues; Target Attribute: CurriculumId
• Display Attribute: CurriculumName

storefrontsLOV

Operation: /fscmRestApi/resources/11.13.18.05/storefrontsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: StorefrontIdentifierValues; Target Attribute: StorefrontId
• Display Attribute: StorefrontName

subjectsLOV

Operation: /fscmRestApi/resources/11.13.18.05/subjectsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicSubjectIdentifierValues; Target Attribute: AcademicSubjectId
• Display Attribute: AcademicSubjectName

Back to Top