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

機械翻訳について

セルフサービス・ユーザーのロールの作成

post

/crmRestApi/resources/11.13.18.05/selfServiceRoles

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AccountPartyId: integer (int64)

タイトル: Account ID

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

タイトル: Contact ID

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

タイトル: Login ID

最大長: 320

ロールに関連付けられたセルフサービス・ユーザーのログインID。
RelationshipTypeCd: string

タイトル: Relationship Type

最大長: 320

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

タイトル: Request Type

最大長: 30

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

{
    "type":"object",
    "properties":{
        "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_REQ_TYPE_CD.",
            "nullable":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"
            }
        },
        "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
            }
        },
        "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
            }
        },
        "LoginId":{
            "title":"Login ID",
            "maxLength":320,
            "type":"string",
            "description":"The login Id of the self-service user associated with the role.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : 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

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

タイトル: Request Type

最大長: 30

登録リクエストのタイプを示すコード。受け入れられる値のリストは、参照タイプORA_SVC_CSS_REQ_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 if 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_REQ_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 account 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 code indicating the role type. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD.",
            "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 self service role starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The account party name 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 if 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"
    }
}

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

タイプ: 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."
        }
    }
}

リンク

RelationshipTypeCDLookupVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CSS_REL_TYPE_CD

関係のタイプを示す値リスト。参照タイプはORA_SVC_CSS_REL_TYPE_CDです。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: RelationshipTypeCd;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

次のURI構文でPOSTを使用してロールを作成し、それをセルフサービス・ユーザーに追加します:

リクエストURIの例

次に、リクエストURLの例を示します。

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles

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

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

POST  crmRestApi/resources/11.13.18.05/selfServiceRoles HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

Content type:
{
  "AccountPartyId": "300100091492019",
  "ContactPartyId": "300100095936284",
  "RelationshipTypeCd": "ORA_CSS_ACC_ADMIN"
}

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

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

HTTP/1.1 201 CREATED
Date: Fri, 17 Mar 2017 06:14:10 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

Content type:
{
  "AccountPartyId": 300100091492019,
  "ContactPartyId": 300100095936284,
  "CreatedBy": "css_dev_user@oracle.com",
  "CreationDate": "2017-03-16T23:14:16-07:00",
  "EndDate": null,
  "LastUpdateDate": "2017-03-16T23:14:16-07:00",
  "LastUpdateLogin": "4ADF2E4575BA2EAFE0530E8EF50AAAF4",
  "LastUpdatedBy": "css_dev_user@oracle.com",
  "RegistrationId": null,
  "RelationshipTypeCd": "ORA_CSS_ACC_ADMIN",
  "RoleId": 300100095936466,
  "StartDate": "2017-03-16",
  "AccountPartyName": "CSS ABCS Test 1",
  "ContactPartyName": "csstest123@oracle.com",
  "EmailAddress": "csstest123@oracle.com",
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466",
      "name": "selfServiceRoles",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466",
      "name": "selfServiceRoles",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466/lov/RelationshipTypeCDLookupVO",
      "name": "RelationshipTypeCDLookupVO",
      "kind": "collection"
    }
  ]
}

「トップに戻る」