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

機械翻訳について

アセット担当者の作成

post

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts

リクエスト

パス・パラメータ

AssetId(required): integer(int64)

アセットの一意の識別子。

ヘッダー・パラメータ

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

ソースを表示

AssetContactId: integer (int64)

タイトル: Asset Contact ID

アセットに関連付けられているプライマリ担当者の一意の識別子。
AssetId: integer (int64)

タイトル: Asset ID

アセットの一意の識別子。
ContactFunctionCode: string

タイトル: Function

最大長: 30

担当者の機能を示すコード。有効な値のリストは、参照FunctionTypesLookupPVOで定義されます。
ContactPartyId: integer (int64)

タイトル: Contact Party ID

プライマリ担当者に関連付けられたパーティの一意の識別子。
ContactSourceSystem: string

タイトル: Contact Source System

アセットに関連付けられた担当者のソースとなるシステム。
ContactSourceSystemReference: string

タイトル: Contact Source System Reference

アセットに関連付けられた担当者がソーシングされる参照システム。
PrimaryFlag: boolean

タイトル: Primary

アセット担当者がプライマリ担当者であるかどうかを示します。値がtrueの場合、アセット担当者はプライマリ担当者です。

{
    "type":"object",
    "properties":{
        "AssetContactId":{
            "title":"Asset Contact ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact associated with the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactSourceSystemReference":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"The reference system from where the contact associated with the asset is sourced.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the asset contact is the primary contact. If the value is true, then the asset contact is a primary contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactPartyId"
                ]
            }
        },
        "ContactFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a contact. A list of valid values is defined in the lookup FunctionTypesLookupPVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The system from where the contact associated with the asset is sourced.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the primary contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the Asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : assets-assetContacts-item-response

タイプ: object

ソースを表示

AssetContactId: integer (int64)

タイトル: Asset Contact ID

アセットに関連付けられているプライマリ担当者の一意の識別子。
AssetId: integer (int64)

タイトル: Asset ID

アセットの一意の識別子。
AssetNumber: string

タイトル: Asset Number

読取り専用: true

最大長: 100

アセットを識別する番号。
ContactFunctionCode: string

タイトル: Function

最大長: 30

担当者の機能を示すコード。有効な値のリストは、参照FunctionTypesLookupPVOで定義されます。
ContactPartyId: integer (int64)

タイトル: Contact Party ID

プライマリ担当者に関連付けられたパーティの一意の識別子。
ContactPartyNumber: string

タイトル: Contact Party Number

読取り専用: true

最大長: 30

アセットに関連付けられている担当者の一意の識別子。
ContactSourceSystem: string

タイトル: Contact Source System

アセットに関連付けられた担当者のソースとなるシステム。
ContactSourceSystemReference: string

タイトル: Contact Source System Reference

アセットに関連付けられた担当者がソーシングされる参照システム。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成またはインポートしたユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

アセットに関連付けられたプライマリ担当者の電子メール・アドレス。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

アセットに関連付けられているプライマリ担当者のフォーマット済電話番号。
JobTitle: string

タイトル: Job Title

読取り専用: true

最大長: 100

アセット担当者のジョブのタイトル。
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

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

タイトル: Party ID

読取り専用: true

アセットに関連付けられた取引先または担当者の一意の識別子。
PartyName: string

タイトル: Name

読取り専用: true

最大長: 360

プライマリ担当者に関連付けられたパーティの名前。
PersonProfileId: integer (int64)

タイトル: Contact Party ID

読取り専用: true

担当者プロファイルの一意の識別子。
PrimaryFlag: boolean

タイトル: Primary

アセット担当者がプライマリ担当者であるかどうかを示します。値が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
        },
        "AssetContactId":{
            "title":"Asset Contact ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact associated with the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created or imported the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the asset contact is the primary contact. If the value is true, then the asset contact is a primary contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactPartyId"
                ]
            }
        },
        "ContactFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a contact. A list of valid values is defined in the lookup FunctionTypesLookupPVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The system from where the contact associated with the asset is sourced.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of the job of the asset contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":100,
            "type":"string",
            "description":"The number that identifies the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the primary contact associated with the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the contact associated with the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactSourceSystemReference":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"The reference system from where the contact associated with the asset is sourced.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account, or contact associated with the asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the primary contact associated with the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonProfileId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the contacts profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the primary contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the Asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the 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 details of the user who last updated the record in the interface table or submitted the import process.",
            "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"
    }
}

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

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

リンク

FunctionTypesLookupPVO

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ContactFunctionCode}%2CBindLookupType%3DORA_ZCM_CONTACT_FUNCTION

参照リソースは、標準参照コードの表示に使用されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、アセット担当者を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/assets/785805215/child/assetContacts

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{		
	"ContactPartyId": 2448
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "AssetContactId": 300100168153850,
    "AssetId": 785805215,
    "ContactPartyId": 2448,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2018-09-25T09:55:29+00:00",
    "LastUpdateDate": "2018-09-25T09:55:29.141+00:00",
    "LastUpdateLogin": "76AF2964E73B33C2E053773AF80A77BF",
    "LastUpdatedBy": "SALES_ADMIN",
    "ContactFunctionCode": null,
    "PartyName": "Lisa Smith",
    "EmailAddress": "sendmail-test-discard@oracle.com",
    "FormattedPhoneNumber": "+1 (800) 555-8355",
    "PartyId": 2448,
    "PrimaryFlag": false,
    "JobTitle": null,
    "PersonProfileId": 274466,
    "ContactPartyNumber": "CONTACT-1010",
    "links": [
		...
		]
	}

「トップに戻る」