REST API for Oracle Fusion Cloud Student Management

Create a new data security profile

post

/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles

Request

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

BusinessObjectId(required): integer (int64)

Title: Business Object

Unique identifier of the business object used to configure data security.
BusinessObjectName(required): string

Title: Business Object

Maximum Length: 240

Name of the business object.
GlobalSetFlag: boolean

Title: Global Set Indicator

Maximum Length: 1

Default Value: false

Attribute to indicate a global set.
ProfileDescription: string

Title: Security Profile Description

Maximum Length: 1000

Description of the security profile.
profileFields: array Profile Fields

Title: Profile Fields

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.
ProfileName(required): string

Title: Data Profile Name

Maximum Length: 100

Name of the security profile.

{
    "required":[
        "BusinessObjectId",
        "BusinessObjectName",
        "ProfileName"
    ],
    "type":"object",
    "properties":{
        "ProfileDescription":{
            "title":"Security Profile Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the security profile.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "profileFields":{
            "title":"Profile Fields",
            "type":"array",
            "description":"The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-item-post-request"
            }
        },
        "ProfileName":{
            "title":"Data Profile Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the security profile.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "BusinessObjectName":{
            "title":"Business Object",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "GlobalSetFlag":{
            "title":"Global Set Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Attribute to indicate a global set.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "BusinessObjectId":{
            "title":"Business Object",
            "type":"integer",
            "description":"Unique identifier of the business object used to configure data security.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Profile Fields

Type: array

Title: Profile Fields

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.

Show Source

Array of: object hedDataSecurityProfiles-profileFields-item-post-request

{
    "title":"Profile Fields",
    "type":"array",
    "description":"The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-item-post-request"
    }
}

Nested Schema : hedDataSecurityProfiles-profileFields-item-post-request

Type: object

Show Source

FieldId: integer (int64)

Title: Field

Unique identifier of the field.

{
    "type":"object",
    "properties":{
        "FieldId":{
            "title":"Field",
            "type":"integer",
            "description":"Unique identifier of the field.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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.

Root Schema : hedDataSecurityProfiles-item-response

Type: object

Show Source

BusinessObjectId: integer (int64)

Title: Business Object

Unique identifier of the business object used to configure data security.
BusinessObjectName: string

Title: Business Object

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.
FunctionalAreaCode: string

Title: Functional Area Code

Read Only: true

Maximum Length: 30

The unique identifier code of the functional area under which the application pages are categorized.
FunctionalAreaMeaning: string

Title: Meaning

Read Only: true

Maximum Length: 80

Meaning of the functional area of the security profile.
GlobalSetFlag: boolean

Title: Global Set Indicator

Maximum Length: 1

Default Value: false

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.
ProfileDescription: string

Title: Security Profile Description

Maximum Length: 1000

Description of the security profile.
profileFields: array Profile Fields

Title: Profile Fields

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.
ProfileId: integer (int64)

Title: Security Profile ID

Read Only: true

Unique identifier of the security profile used for data security.
ProfileName: string

Title: Data Profile Name

Maximum Length: 100

Name of the security profile.
SeedDataLock: integer (int32)

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":{
        "ProfileId":{
            "title":"Security Profile ID",
            "type":"integer",
            "description":"Unique identifier of the security profile used for data security.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "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",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProfileDescription":{
            "title":"Security Profile Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the security profile.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "profileFields":{
            "title":"Profile Fields",
            "type":"array",
            "description":"The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-item-response"
            }
        },
        "ProfileName":{
            "title":"Data Profile Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the security profile.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FunctionalAreaCode":{
            "title":"Functional Area Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier code of the functional area under which the application pages are categorized.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FunctionalAreaMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the functional area of the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GlobalSetFlag":{
            "title":"Global Set Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Attribute to indicate a global set.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessObjectId":{
            "title":"Business Object",
            "type":"integer",
            "description":"Unique identifier of the business object used to configure data security.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessObjectName":{
            "title":"Business Object",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 : Profile Fields

Type: array

Title: Profile Fields

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.

Show Source

Array of: object hedDataSecurityProfiles-profileFields-item-response

{
    "title":"Profile Fields",
    "type":"array",
    "description":"The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-item-response"
    }
}

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."
        }
    }
}

Nested Schema : hedDataSecurityProfiles-profileFields-item-response

Type: object

Show Source

AssignmentFieldName: string

Title: Assignment Field Name

Read Only: true

Maximum Length: 50

Name of the assignment field used on the security profile.
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.
FieldDataType: string

Title: Field Data Type

Read Only: true

Maximum Length: 20

Data type of the field used for the security profile.
FieldDescription: string

Title: Field Description

Read Only: true

Maximum Length: 1000

Description of the field used for the security profile.
FieldDisplay: string

Title: Field Display

Read Only: true

Maximum Length: 100

Display value of the field used for the security profile.
FieldId: integer (int64)

Title: Field

Unique identifier of the field.
FieldLOVDisplayFields: string

Title: Field LOV Display Fields

Read Only: true

Maximum Length: 50

The comma separated list of list of value resource field names that's used to get the value from for display purposes.
FieldLOVResourcePath: string

Title: Field LOV Resource Path

Read Only: true

Maximum Length: 250

The list of values resource path to get the list of values for this field.
FieldLOVSourceField: string

Title: Field LOV Source Field

Read Only: true

Maximum Length: 50

The field name of the list of value resource to get the value from for the assignment to the business object field.
FieldOperatorCode: string

Title: Field Operator Code

Read Only: true

Maximum Length: 30

Unique identifier of the field operator used for the security profile.
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.
ProfileFieldId: integer (int64)

Title: Profile Field ID

Read Only: true

Unique identifier of the security profile.
SupportMultiValueFlag: boolean

Title: Field Multiple Value Indicator

Read Only: true

Maximum Length: 1

Field used to store the indicator for multiple values for the security profile.
SupportNullValueFlag: boolean

Title: Field Null Value Indicator

Read Only: true

Maximum Length: 1

Field used to store the indicator for a Null attribute for the security profile.

{
    "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldDataType":{
            "title":"Field Data Type",
            "maxLength":"20",
            "type":"string",
            "description":"Data type of the field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldLOVResourcePath":{
            "title":"Field LOV Resource Path",
            "maxLength":"250",
            "type":"string",
            "description":"The list of values resource path to get the list of values for this field.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldDisplay":{
            "title":"Field Display",
            "maxLength":"100",
            "type":"string",
            "description":"Display value of the field used for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProfileFieldId":{
            "title":"Profile Field ID",
            "type":"integer",
            "description":"Unique identifier of the security profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupportNullValueFlag":{
            "title":"Field Null Value Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Field used to store the indicator for a Null attribute for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldDescription":{
            "title":"Field Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldLOVDisplayFields":{
            "title":"Field LOV Display Fields",
            "maxLength":"50",
            "type":"string",
            "description":"The comma separated list of list of value resource field names that's used to get the value from for display purposes.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldOperatorCode":{
            "title":"Field Operator Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier of the field operator used for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupportMultiValueFlag":{
            "title":"Field Multiple Value Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Field used to store the indicator for multiple values for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldId":{
            "title":"Field",
            "type":"integer",
            "description":"Unique identifier of the field.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldLOVSourceField":{
            "title":"Field LOV Source Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field name of the list of value resource to get the value from for the assignment to the business object field.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignmentFieldName":{
            "title":"Assignment Field Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the assignment field used on the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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"
    }
}

Links

BusinessObjectNameLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects

Parameters:

finder: HavingSecurityFieldFinder

The list of values for the object names.

functionalAreaCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_HED_FUNCTIONAL_AREA

The list of values for the functional area codes.

profileFields

Operation: /fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields

Parameters:

ProfileId: $request.path.ProfileId

The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.