REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all the self-service users

get

/crmRestApi/resources/11.13.18.05/selfServiceUsers

Request

Query Parameters

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
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds a user with the specified primary key.
  Finder Variables:
  - UserId; number; The unique identifier of the self-service user.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

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

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- Account; string; The name of the account associated with the self-service user.
- AccountPartyId; integer; The unique identifier of the account associated with the self-service user.
- AccountPartyNumber; string; The unique identifier of the account associated with the self-service user.
- ContactPartyId; integer; The unique identifier of the contact record associated with the self-service user.
- ContactPartyNumber; string; The unique identifier of the contact record associated with the self-service user.
- EmailAddress; string; The email of the self-service user.
- LastUpdateDate; string; The date when the record was last updated.
- Name; string; The name of the self-service user.
- RoleId; number; This unique identifier of the self-service user. This attribute has been deprecated.
- RoleName; string; 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.
- UserId; number; The unique identifier of the self-service user.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

Metadata-Context: string

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

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:

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

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/selfServiceUsers-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object selfServiceUsers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/selfServiceUsers-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 : selfServiceUsers-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "Account":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account associated with the self-service user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the self-service user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "type":"string",
            "description":"The unique identifier of the account associated with the self-service user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record associated with the self-service user.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "type":"string",
            "description":"The unique identifier of the contact record associated with the self-service user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the self-service user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the self-service user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"number",
            "description":"This unique identifier of the self-service user. This attribute has been deprecated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfServiceRoles":{
            "title":"Self-Service Roles",
            "type":"array",
            "description":"The self-service roles resource is used to view, create, update, and delete roles for self-service users.",
            "items":{
                "$ref":"#/components/schemas/selfServiceUsers-SelfServiceRoles-item-response"
            }
        },
        "SelfServiceRolesHistory":{
            "title":"Self-Service Roles Histories",
            "type":"array",
            "description":"The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.",
            "items":{
                "$ref":"#/components/schemas/selfServiceUsers-SelfServiceRolesHistory-item-response"
            }
        },
        "UserId":{
            "title":"User ID",
            "type":"number",
            "description":"The unique identifier of the self-service user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Array of: object selfServiceUsers-SelfServiceRoles-item-response

{
    "title":"Self-Service Roles",
    "type":"array",
    "description":"The self-service roles resource is used to view, create, update, and delete roles for self-service users.",
    "items":{
        "$ref":"#/components/schemas/selfServiceUsers-SelfServiceRoles-item-response"
    }
}

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

Array of: object selfServiceUsers-SelfServiceRolesHistory-item-response

{
    "title":"Self-Service Roles Histories",
    "type":"array",
    "description":"The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.",
    "items":{
        "$ref":"#/components/schemas/selfServiceUsers-SelfServiceRolesHistory-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 : selfServiceUsers-SelfServiceRoles-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account of the self-service user associated with the role.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account of the self-service user associated with the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the account of the self-service user associated with the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CanDeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "CanUpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record of the self-service user associated with the role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact record of the self-service user associated with the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the contact record of the self-service user associated with the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the role record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the role record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the self-service user associated with the role.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role was deleted from the user.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the role record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoginId":{
            "title":"Login ID",
            "maxLength":320,
            "type":"string",
            "description":"The login Id of the self-service user associated with the role.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistrationId":{
            "title":"Registration ID",
            "type":"integer",
            "description":"The unique identifier of the self-service registration request whose approval was used to grant the role.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipTypeCd":{
            "title":"Relationship Type",
            "maxLength":320,
            "type":"string",
            "description":"The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipTypeCdMeaning":{
            "title":"Role Value",
            "maxLength":80,
            "type":"string",
            "description":"The description of the role type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestTypeCd":{
            "title":"Request Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier of the role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role is assigned to the self-service user.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : selfServiceUsers-SelfServiceRolesHistory-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account of the self-service user associated with the role history.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account of the self-service user associated with the role history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "title":"Date",
            "type":"string",
            "description":"The date when the role history was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionUserId":{
            "title":"Administrator Login",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the administrator who updated the role history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionUserName":{
            "title":"Administrator",
            "maxLength":255,
            "type":"string",
            "description":"The name of the administrator who updated the role history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record of the self-service user associated with the role history.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact record of the self-service user associated with the role history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "maxLength":41,
            "type":"string",
            "description":"The unique identifier of the role history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The description of the role type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":320,
            "type":"string",
            "description":"The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the role history. The status can be Granted or Revoked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Examples

The following example shows how to get all self-service users 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

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.

{
  "items" : [ {
    "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"
    } ]
  }, {
    "AccountPartyId" : 300100036239456,
    "ContactPartyId" : 300100095380956,
    "Account" : "Auto",
    "Name" : "Dak Prescott",
    "EmailAddress" : "dak.prescott@oracle.com",
    "RoleId" : 300100095380961,
    "LastUpdateDate" : "2017-01-23T06:44:33-08:00",
    "RoleName" : "Account Manager, User",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095380961",
      "name" : "selfServiceUsers",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095380961",
      "name" : "selfServiceUsers",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceUsers/300100095380961/child/SelfServiceRoles",
      "name" : "SelfServiceRoles",
      "kind" : "collection"
    } ]
  }
  ...
  }