REST API for Oracle Fusion Cloud Student Management

Get a user account

get

/fscmRestApi/resources/11.13.18.05/hedUserAccounts/{UserId}

Request

Path Parameters

UserId(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=

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context(required):

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

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

Root Schema : hedUserAccounts-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.
EmailAddress: string

Title: Email

Read Only: true

Maximum Length: 320

The email ID of the user who can sign in to Oracle Student Management Cloud.
FirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The first name of the user who can sign in to Oracle Student Management Cloud.
FullName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the party that can sign in to Oracle Student Management Cloud.
IsSuspenedFlag: boolean

Title: Suspended

Read Only: true

Maximum Length: 30

Indicates the status of the user account if the account is suspended and can no longer be used.
LastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The last name of the user who can sign in to Oracle Student Management Cloud.
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.
MiddleName: string

Title: Middle Name

Read Only: true

Maximum Length: 60

The middle name of the user who can sign in to Oracle Student Management Cloud.
UserGUID: string

Title: User GUID

Read Only: true

Maximum Length: 64

The GUID of the user account.
UserId: integer (int64)

Title: User ID

Read Only: true

Unique identifier for the user who can sign in to Oracle Student Management Cloud.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 100

The user name of the user account that can sign in to Oracle Student Management Cloud.
userSecurityRoles: array User Security Roles

Title: User Security Roles

The user security roles resource provides the list of all security roles available in the application.

{
    "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"The user name of the user account that can sign in to Oracle Student Management Cloud.",
            "nullable":true,
            "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
        },
        "UserGUID":{
            "title":"User GUID",
            "maxLength":64,
            "type":"string",
            "description":"The GUID of the user account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the user who can sign in to Oracle Student Management Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the user who can sign in to Oracle Student Management Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email ID of the user who can sign in to Oracle Student Management Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"Unique identifier for the user who can sign in to Oracle Student Management Cloud.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party that can sign in to Oracle Student Management Cloud.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "userSecurityRoles":{
            "title":"User Security Roles",
            "type":"array",
            "description":"The user security roles resource provides the list of all security roles available in the application.",
            "items":{
                "$ref":"#/components/schemas/hedUserAccounts-userSecurityRoles-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsSuspenedFlag":{
            "title":"Suspended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates the status of the user account if the account is suspended and can no longer be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the user who can sign in to Oracle Student Management Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : User Security Roles

Type: array

Title: User Security Roles

The user security roles resource provides the list of all security roles available in the application.

Show Source

Array of: object hedUserAccounts-userSecurityRoles-item-response

{
    "title":"User Security Roles",
    "type":"array",
    "description":"The user security roles resource provides the list of all security roles available in the application.",
    "items":{
        "$ref":"#/components/schemas/hedUserAccounts-userSecurityRoles-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 : hedUserAccounts-userSecurityRoles-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.
Description: string

Title: Description

Read Only: true

Maximum Length: 240

Detailed information about the user security role.
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.
RoleCode: string

Title: Role Code

Read Only: true

Maximum Length: 240

Code for the short form of the role name.
RoleId: integer (int64)

Title: Role ID

Read Only: true

Unique identifier for the role.
RoleName: string

Title: Role Name

Read Only: true

Maximum Length: 240

Full name of the role.
UserRoleId: integer (int64)

Read Only: true

Unique identifier for the user role.

{
    "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":240,
            "type":"string",
            "description":"Full name of the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Detailed information about the user security role.",
            "nullable":true,
            "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
        },
        "UserRoleId":{
            "type":"integer",
            "description":"Unique identifier for the user role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"Unique identifier for the role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":240,
            "type":"string",
            "description":"Code for the short form of the role name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

userSecurityRoles

Operation: /fscmRestApi/resources/11.13.18.05/hedUserAccounts/{UserId}/child/userSecurityRoles

Parameters:

UserId: $request.path.UserId

The user security roles resource provides the list of all security roles available in the application.