REST API for Oracle Fusion Cloud Financials

Update a data assignment for a user

patch

/fscmRestApi/resources/11.13.18.05/dataSecurities/{UserRoleDataAssignmentId}

Request

Path Parameters

UserRoleDataAssignmentId(required): integer(int64)

The numerical value that uniquely identifies a user data role.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ActiveFlag: boolean

Title: Active

Maximum Length: 1

Default Value: true

Indicates whether the data security access is active. The default value is ACTIVE.
RoleCommonName: string

Title: Role

Maximum Length: 256

The technical name of role where the data security assignment applies to the user. The role must be assigned to the user separately.
RoleNameCr: string

Title: Role Name

The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.
SecurityContext: string

Title: Security Context

Maximum Length: 255

The category of data access that is required for the role. The category includes business unit, asset book, and inventory organization.
SecurityContextValue: string

Title: Security Context Value

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for a single-part security context or the value for the first part of a multi-part context.
SecurityContextValue2: string

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for the second part of a multi-part context.
SecurityContextValue3: string

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for the third part of a multi-part context.
UserName: string

Title: User Name

The unique identifier for a user defined in the application that allows account access.
UserRoleDataAssignmentId: integer (int64)

Title: User Role Data Assignment Identifier

The numerical value that uniquely identifies a user data role.

{
    "type":"object",
    "properties":{
        "SecurityContextValue2":{
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. \nThis is the value for the second part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleCommonName":{
            "title":"Role",
            "maxLength":"256",
            "type":"string",
            "description":"The technical name of role where the data security assignment applies to the user. The role must be assigned to the user separately.",
            "nullable":true
        },
        "SecurityContextValue3":{
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. \nThis is the value for the third part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserName":{
            "title":"User Name",
            "type":"string",
            "description":"The unique identifier for a user defined in the application that allows account access.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SecurityContextValue":{
            "title":"Security Context Value",
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for a single-part security context or the value for the first part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SecurityContext":{
            "title":"Security Context",
            "maxLength":"255",
            "type":"string",
            "description":"The category of data access that is required for the role. The category includes business unit, asset book, and inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserRoleDataAssignmentId":{
            "title":"User Role Data Assignment Identifier",
            "type":"integer",
            "description":"The numerical value that uniquely identifies a user data role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RoleNameCr":{
            "title":"Role Name",
            "type":"string",
            "description":"The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the data security access is active. The default value is ACTIVE.",
            "nullable":true,
            "default":true
        }
    }
}

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 : dataSecurities-item-response

Type: object

Show Source

ActiveFlag: boolean

Title: Active

Maximum Length: 1

Default Value: true

Indicates whether the data security access is active. The default value is ACTIVE.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the row.
CreationDate: string (date-time)

Read Only: true

The date and time when the row was created.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the row was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the row.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The session login of the user who last updated the row.
links: array Links

Title: Links

The link relations associated with the resource instance.
RoleCommonName: string

Title: Role

Maximum Length: 256

The technical name of role where the data security assignment applies to the user. The role must be assigned to the user separately.
RoleNameCr: string

Title: Role Name

The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.
Rolerf: string

Title: Role Name

Read Only: true

Maximum Length: 240

The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.
SecurityContext: string

Title: Security Context

Maximum Length: 255

The category of data access that is required for the role. The category includes business unit, asset book, and inventory organization.
SecurityContextValue: string

Title: Security Context Value

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for a single-part security context or the value for the first part of a multi-part context.
SecurityContextValue2: string

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for the second part of a multi-part context.
SecurityContextValue3: string

Maximum Length: 255

The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for the third part of a multi-part context.
UserName: string

Title: User Name

The unique identifier for a user defined in the application that allows account access.
Userrf: string

Title: User Name

Read Only: true

Maximum Length: 100

The user name that is a unique identifier of the user who allows account access. The user is defined in the application.
UserRoleDataAssignmentId: integer (int64)

Title: User Role Data Assignment Identifier

The numerical value that uniquely identifies a user data role.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleCommonName":{
            "title":"Role",
            "maxLength":"256",
            "type":"string",
            "description":"The technical name of role where the data security assignment applies to the user. The role must be assigned to the user separately.",
            "nullable":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "type":"string",
            "description":"The unique identifier for a user defined in the application that allows account access.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the data security access is active. The default value is ACTIVE.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "Userrf":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user name that is a unique identifier of the user who allows account access. The user is defined in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurityContextValue2":{
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. \nThis is the value for the second part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecurityContextValue3":{
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. \nThis is the value for the third part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Rolerf":{
            "title":"Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurityContextValue":{
            "title":"Security Context Value",
            "maxLength":"255",
            "type":"string",
            "description":"The value of the security context associated with a role. For example, for a specific business unit, a financials job role is assigned the security context of that business unit. This value can be used as a criteria for assigning data access to a user name. This is the value for a single-part security context or the value for the first part of a multi-part context.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecurityContext":{
            "title":"Security Context",
            "maxLength":"255",
            "type":"string",
            "description":"The category of data access that is required for the role. The category includes business unit, asset book, and inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserRoleDataAssignmentId":{
            "title":"User Role Data Assignment Identifier",
            "type":"integer",
            "description":"The numerical value that uniquely identifies a user data role.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "RoleNameCr":{
            "title":"Role Name",
            "type":"string",
            "description":"The name of the role for which the data security assignment is applicable. You must separately assign the role to the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the row.",
            "nullable":true,
            "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."
        }
    }
}

Examples

The following example shows how to update a user assignment by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataSecurities/300100089632748

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
"ActiveFlag": false
}

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json
application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "ActiveFlag": false,
    "UserRoleDataAssignmentId": 300100089632748,
    "Rolerf" : "Financial Analyst",
    "Userrf" : "FUSION_APPS_FSCM_ENT_MANAGER",
    "SecurityContext" : "Asset book",
    "SecurityContextValue" : "VISION LEASE CORPORATE BOOK",
    "UserName" : "FUSION_APPS_FSCM_ENT_MANAGER",
    "RoleNameCr" : "Financial Analyst",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRESTApi/resources/11.13.18.05/datasecurities/300100089632748",
            "name": "datasecurities",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRESTApi/resources/11.13.18.05/datasecurities/300100089632748",
            "name": "datasecurities",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRESTApi/resources/11.13.18.05/datasecurities/300100089632748/lov/DataSecurityAM_UserNameLov1_1",
            "name": "DataSecurityAM_UserNameLov1_1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRESTApi/resources/11.13.18.05/datasecurities/300100089632748/lov/DataSecurityAM_RoleP1_1",
            "name": "DataSecurityAM_RoleP1_1",
            "kind": "collection"
        }
    ]
}