Get a self-service user
get
/crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}
Request
Path Parameters
-
UserId(required): number
The unique identifier of the self-service user.
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.
Back to TopResponse
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 : selfServiceUsers-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the account associated with the self-service user. -
AccountPartyId: integer
Title:
Account ID
Read Only:true
The unique identifier of the account associated with the self-service user. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
The unique identifier of the account associated with the self-service user. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the contact record associated with the self-service user. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
The unique identifier of the contact record associated with the self-service user. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email of the self-service user. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the self-service user. -
RoleId: number
Title:
Role ID
Read Only:true
This unique identifier of the self-service user. This attribute has been deprecated. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:4000
The names of the roles assigned to a self-service user such as Customer Self-Service User, Customer Self-Service Account Manager, or Customer Self-Service Administrator. A list of accepted roles is defined in the lookup ORA_SVC_CSS_REL_TYPE_CD. -
SelfServiceRoles: array
Self-Service Roles
Title:
Self-Service Roles
The self-service roles resource is used to view, create, update, and delete roles for self-service users. -
SelfServiceRolesHistory: array
Self-Service Roles Histories
Title:
Self-Service Roles Histories
The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user. -
UserId: number
Title:
User ID
Read Only:true
The unique identifier of the self-service user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Self-Service Roles
Type:
array
Title:
Self-Service Roles
The self-service roles resource is used to view, create, update, and delete roles for self-service users.
Show Source
Nested Schema : Self-Service Roles Histories
Type:
array
Title:
Self-Service Roles Histories
The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : selfServiceUsers-SelfServiceRoles-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account of the self-service user associated with the role. -
AccountPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the account of the self-service user associated with the role. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The unique identifier of the account of the self-service user associated with the role. -
CanDeleteFlag: boolean
Title:
Can Delete
Read Only:true
Default Value:true
Indicates whether the record can be deleted. -
CanUpdateFlag: boolean
Title:
Can Update
Read Only:true
Default Value:false
Indicates whether the record can be updated. The default value is false. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact record of the self-service user associated with the role. -
ContactPartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the contact record of the self-service user associated with the role. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The unique identifier of the contact record of the self-service user associated with the role. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the role record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the role record was created. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the self-service user associated with the role. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the role was deleted from the user. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the role record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoginId: string
Title:
Login ID
Maximum Length:320
The login Id of the self-service user associated with the role. -
RegistrationId: integer
(int64)
Title:
Registration ID
Read Only:true
The unique identifier of the self-service registration request whose approval was used to grant the role. -
RelationshipTypeCd: string
Title:
Relationship Type
Maximum Length:320
The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RelationshipTypeCdMeaning: string
Title:
Role Value
Read Only:true
Maximum Length:80
The description of the role type. -
RequestTypeCd: string
Title:
Request Type
Maximum Length:30
The code indicating the type of registration request. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RoleId: integer
(int64)
Title:
Role ID
Read Only:true
The unique identifier of the role. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the role is assigned to the self-service user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : selfServiceUsers-SelfServiceRolesHistory-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the account of the self-service user associated with the role history. -
AccountPartyName: string
Title:
Account Name
Read Only:true
Maximum Length:360
The name of the account of the self-service user associated with the role history. -
ActionDate: string
(date-time)
Title:
Date
Read Only:true
The date when the role history was updated. -
ActionUserId: string
Title:
Administrator Login
Read Only:true
Maximum Length:64
The unique identifier of the administrator who updated the role history. -
ActionUserName: string
Title:
Administrator
Read Only:true
Maximum Length:255
The name of the administrator who updated the role history. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the contact record of the self-service user associated with the role history. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the contact record of the self-service user associated with the role history. -
HistoryId: string
Title:
History ID
Read Only:true
Maximum Length:41
The unique identifier of the role history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
The description of the role type. -
RelationshipTypeCd: string
Title:
Relationship Type Code
Read Only:true
Maximum Length:320
The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RoleStatus: string
Title:
Status
Read Only:true
The status of the role history. The status can be Granted or Revoked.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SelfServiceRoles
-
Parameters:
- UserId:
$request.path.UserId
The self-service roles resource is used to view, create, update, and delete roles for self-service users. - UserId:
- SelfServiceRolesHistory
-
Operation: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRolesHistoryParameters:
- UserId:
$request.path.UserId
The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user. - UserId:
Examples
The following example shows how to get a specific self-service user by submitting a GET request on the REST resource.
Request Header Example
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095464026
Response Header Example
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Fri, 03 Mar 2017 07:54:53 GMT Server : Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourcecollection+json Content-Language: en
Response Body Example
The following shows an example of the response body in JSON format.
{ "AccountPartyId" : 300100036239456, "ContactPartyId" : 300100095464021, "Account" : "Auto", "Name" : "Bill Jones", "EmailAddress" : "bill.jones@oracle.com", "RoleId" : 300100095464026, "LastUpdateDate" : "2017-01-26T06:13:40-08:00", "RoleName" : "User", "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095464026", "name" : "selfServiceUsers", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095464026", "name" : "selfServiceUsers", "kind" : "item" }, { "rel" : "child", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095464026/child/SelfServiceRoles", "name" : "SelfServiceRoles", "kind" : "collection" } ] }