Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべてのセルフサービス・ユーザーの取得

get

/crmRestApi/resources/11.13.18.05/selfServiceUsers

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定された主キーを持つユーザーを検索します。
  ファインダ変数:
  - UserId; number;セルフサービス・ユーザーの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- Account; string;セルフサービス・ユーザーに関連付けられているアカウントの名前。
- AccountPartyId; integer;セルフサービス・ユーザーに関連付けられたアカウントの一意の識別子。
- AccountPartyNumber; string;セルフサービス・ユーザーに関連付けられたアカウントの一意の識別子。
- ContactPartyId; integer;セルフサービス・ユーザーに関連付けられている担当者レコードの一意の識別子。
- ContactPartyNumber; string;セルフサービス・ユーザーに関連付けられた担当者レコードの一意の識別子。
- EmailAddress; string;セルフサービス・ユーザーの電子メール。
- LastUpdateDate; string; レコードが最後に更新された日付。
- Name; string;セルフサービス・ユーザーの名前。
- RoleId; number;セルフサービス・ユーザーの一意の識別子。この属性は非推奨になりました。
- RoleName; string;顧客セルフサービス・ユーザー、顧客セルフサービス・アカウント・マネージャ、顧客セルフサービス管理者など、セルフサービス・ユーザーに割り当てられるロールの名前。受け入れられるロールのリストは、参照ORA_SVC_CSS_REL_TYPE_CDで定義されます。
- UserId; number;セルフサービス・ユーザーの一意の識別子。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : selfServiceUsers

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/selfServiceUsers-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object selfServiceUsers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/selfServiceUsers-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : selfServiceUsers-item-response

タイプ: object

ソースを表示

Account: string

タイトル: Account

読取り専用: true

最大長: 360

セルフサービス・ユーザーに関連付けられたアカウントの名前。
AccountPartyId: integer

タイトル: Account ID

読取り専用: true

セルフサービス・ユーザーに関連付けられたアカウントの一意の識別子。
AccountPartyNumber: string

タイトル: Account Party Number

読取り専用: true

セルフサービス・ユーザーに関連付けられたアカウントの一意の識別子。
ContactPartyId: integer (int64)

タイトル: Contact ID

読取り専用: true

セルフサービス・ユーザーに関連付けられた担当者レコードの一意の識別子です。
ContactPartyNumber: string

タイトル: Contact Party Number

読取り専用: true

セルフサービス・ユーザーに関連付けられた担当者レコードの一意の識別子です。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

セルフサービス・ユーザーのEメール。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

レコードが最後に更新された日付。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Name

読取り専用: true

最大長: 360

セルフサービス・ユーザーの名前。
RoleId: number

タイトル: Role ID

読取り専用: true

セルフサービス・ユーザーの一意の識別子。この属性は非推奨になりました。
RoleName: string

タイトル: Role

読取り専用: true

最大長: 4000

顧客セルフサービス・ユーザー、顧客セルフサービス・アカウント・マネージャ、顧客セルフサービス管理者など、セルフサービス・ユーザーに割り当てられるロールの名前。受け入れられるロールのリストは、参照ORA_SVC_CSS_REL_TYPE_CDで定義されます。
SelfServiceRoles: array Self-Service Roles

タイトル: Self-Service Roles

セルフサービス・ロール・リソースは、セルフサービス・ユーザーのロールの表示、作成、更新および削除に使用されます。
SelfServiceRolesHistory: array Self-Service Roles Histories

タイトル: Self-Service Roles Histories

セルフサービス・ロール履歴リソースは、セルフサービス・ユーザーに対してロールが付与されたか取り消されたかを表示するために使用されます。
UserId: number

タイトル: User ID

読取り専用: true

セルフサービス・ユーザーの一意の識別子。

{
    "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
        },
        "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"
            }
        },
        "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
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the self-service user.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : セルフサービス・ロール

タイプ: array

タイトル: Self-Service Roles

セルフサービス・ロール・リソースは、セルフサービス・ユーザーのロールの表示、作成、更新および削除に使用されます。

ソースを表示

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

ネストされたスキーマ : セルフサービス・ロールの履歴

タイプ: array

タイトル: Self-Service Roles Histories

セルフサービス・ロール履歴リソースは、セルフサービス・ユーザーに対してロールが付与されたか取り消されたかを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : selfServiceUsers-SelfServiceRoles-item-response

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

ロールに関連付けられているセルフサービス・ユーザーのアカウントの一意の識別子。
AccountPartyName: string

タイトル: Account

読取り専用: true

最大長: 360

ロールに関連付けられているセルフサービス・ユーザーのアカウントの名前。
AccountPartyNumber: string

タイトル: Account Party Number

読取り専用: true

最大長: 30

ロールに関連付けられているセルフサービス・ユーザーのアカウントの一意の識別子。
CanDeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

デフォルト値: true

レコードを削除できるかどうかを示します。
CanUpdateFlag: boolean

タイトル: Can Update

読取り専用: true

デフォルト値: false

レコードを更新できるかどうかを示します。デフォルト値はfalseです。
ContactPartyId: integer (int64)

タイトル: Contact ID

ロールに関連付けられているセルフサービス・ユーザーの担当者レコードの一意の識別子。
ContactPartyName: string

タイトル: Name

読取り専用: true

最大長: 360

ロールに関連付けられているセルフサービス・ユーザーの担当者レコードの名前。
ContactPartyNumber: string

タイトル: Contact Party Number

読取り専用: true

最大長: 30

ロールに関連付けられているセルフサービス・ユーザーの担当者レコードの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

ロール・レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

ロール・レコードが作成された日付。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

ロールに関連付けられているセルフサービス・ユーザーのEメール・アドレス。
EndDate: 文字列(日付)

タイトル: End Date

読取り専用: true

ロールがユーザーから削除された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

ロール・レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
LoginId: string

タイトル: Login ID

最大長: 320

ロールに関連付けられたセルフサービス・ユーザーのログインID。
RegistrationId: integer (int64)

タイトル: Registration ID

読取り専用: true

ロールの付与に許可が使用されたセルフサービス登録リクエストの一意の識別子。
RelationshipTypeCd: string

タイトル: Relationship Type

最大長: 320

ロールのタイプを示すコード。受け入れられる値のリストは、参照タイプORA_SVC_CSS_REL_TYPE_CDで定義されます。
RelationshipTypeCdMeaning: string

タイトル: Role Value

読取り専用: true

最大長: 80

ロール・タイプの摘要。
RequestTypeCd: string

タイトル: Request Type

最大長: 30

登録リクエストのタイプを示すコード。受け入れられる値のリストは、参照タイプORA_SVC_CSS_REL_TYPE_CDで定義されます。
RoleId: integer (int64)

タイトル: Role ID

読取り専用: true

ロールの一意の識別子。
StartDate: 文字列(日付)

タイトル: Start Date

読取り専用: true

ロールがセルフサービス・ユーザーに割り当てられる日付です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the 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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the role 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "RelationshipTypeCdMeaning":{
            "title":"Role Value",
            "maxLength":80,
            "type":"string",
            "description":"The description of the role type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "CanDeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : selfServiceUsers-SelfServiceRolesHistory-item-response

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

読取り専用: true

ロール履歴に関連付けられたセルフサービス・ユーザーのアカウントの一意の識別子。
AccountPartyName: string

タイトル: Account Name

読取り専用: true

最大長: 360

ロール履歴に関連付けられたセルフサービス・ユーザーのアカウントの名前。
ActionDate: string (date-time)

タイトル: Date

読取り専用: true

ロール履歴が更新された日付。
ActionUserId: string

タイトル: Administrator Login

読取り専用: true

最大長: 64

ロール履歴を更新した管理者の一意の識別子。
ActionUserName: string

タイトル: Administrator

読取り専用: true

最大長: 255

ロール履歴を更新した管理者の名前。
ContactPartyId: integer (int64)

タイトル: Contact ID

読取り専用: true

ロール履歴に関連付けられたセルフサービス・ユーザーの担当者レコードの一意の識別子。
ContactPartyName: string

タイトル: Contact Name

読取り専用: true

最大長: 360

ロール履歴に関連付けられたセルフサービス・ユーザーの担当者レコードの名前。
HistoryId: string

タイトル: History ID

読取り専用: true

最大長: 41

ロール履歴の一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
RelationshipType: string

タイトル: Relationship Type

読取り専用: true

最大長: 80

ロール・タイプの摘要。
RelationshipTypeCd: string

タイトル: Relationship Type Code

読取り専用: true

最大長: 320

ロールのタイプを示すコード。受け入れられる値のリストは、参照タイプORA_SVC_CSS_REL_TYPE_CDで定義されます。
RoleStatus: string

タイトル: Status

読取り専用: true

ロール履歴のステータス。ステータスは付与済または取消済です。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "HistoryId":{
            "title":"History ID",
            "maxLength":41,
            "type":"string",
            "description":"The unique identifier of the role history.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The description of the role type.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "ActionDate":{
            "title":"Date",
            "type":"string",
            "description":"The date when the role history was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべてのセルフサービス・ユーザーを取得する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET  /crmRestApi/resources/11.13.18.05/selfServiceUsers

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

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

応答本文の例

次に、JSON形式のレスポンス本文の例を示します。

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

「トップに戻る」