機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

担当者メンバーの作成

post

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts

リクエスト

パス・パラメータ

• SrId(required): integer(int64)
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• AccessLevelCd: string
  タイトル: Access Level

  最大長: 30

  サービス・リクエスト担当者に付与されるアクセス・レベル。
• ContactPartyName: string
  タイトル: Name

  最大長: 360

  サービス・リクエスト担当者の名前。
• ContactTypeCd: string
  タイトル: Contact Type

  最大長: 30

  顧客やパートナなどのサービス・リクエスト担当者タイプ。
• ContactUniqueName: string
  タイトル: Unique Name

  最大長: 900

  担当者の一意のパーティ名。
• MemberId: integer (int64)
  タイトル: Member ID

  担当者の一意の識別子。
• PartyId: integer (int64)
  タイトル: Party ID

  担当者の一意のパーティ識別子。
• PersonId: integer (int64)
  タイトル: Person ID

  担当者の一意のPerson ID。
• PrimaryContactFlag: boolean
  タイトル: Primary

  担当者がサービス・リクエストのプライマリ担当者かどうかを示します。 はいの場合、値はTrueで、そうでない場合はFalseです。
• RelationTypeCd: string
  タイトル: Relationship Type Code

  最大長: 30

  サービス・リクエストのコンテキストにおける担当者との関係。 たとえば、代替、フォロワ、Third_Partyなどです。
• SrId: integer (int64)
  タイトル: Service Request ID

  関連付けられたサービス・リクエストの一意の識別子。
• SrNumber: string
  タイトル: Service Request Number

  最大長: 30

  サービス・リクエスト番号の代替キー。

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name of the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the service request contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : internalServiceRequests-contacts-item-response

タイプ: object

ソースを表示

• AccessLevelCd: string
  タイトル: Access Level

  最大長: 30

  サービス・リクエスト担当者に付与されるアクセス・レベル。
• AccountName: string
  タイトル: Account Name

  読取り専用: true

  最大長: 900

  サービス・リクエスト担当者のプライマリ取引先。
• ContactEmailAddress: string
  タイトル: Email

  読取り専用: true

  最大長: 320

  担当者の電子メール・アドレス。
• ContactFormattedPhoneNumber: string
  タイトル: Phone

  読取り専用: true

  担当者の書式設定された電話番号。
• ContactPartyName: string
  タイトル: Name

  最大長: 360

  サービス・リクエスト担当者の名前。
• ContactPartyNumber: string
  タイトル: Contact Number

  読取り専用: true

  最大長: 30

  担当者識別子の代替キー。
• ContactPreferredContactMethod: string
  タイトル: Preferred Contact Method

  読取り専用: true

  最大長: 30

  担当者の優先連絡メソッド。
• ContactTypeCd: string
  タイトル: Contact Type

  最大長: 30

  顧客やパートナなどのサービス・リクエスト担当者タイプ。
• ContactUniqueName: string
  タイトル: Unique Name

  最大長: 900

  担当者の一意のパーティ名。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サービス・リクエストのメンバーとして担当者を追加したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• DeleteFlag: boolean
  タイトル: Can Delete

  読取り専用: true

  レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
• DoNotContactFlag: boolean
  タイトル: Do Not Contact

  読取り専用: true

  最大長: 1

  サービス・リクエストの担当者に連絡を希望しないかどうかを示します。
• FormattedAddress: string
  タイトル: Formatted Address

  読取り専用: 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

  リソース・インスタンスに関連付けられたリンク関係。
• MemberId: integer (int64)
  タイトル: Member ID

  担当者の一意の識別子。
• PartyId: integer (int64)
  タイトル: Party ID

  担当者の一意のパーティ識別子。
• PersonId: integer (int64)
  タイトル: Person ID

  担当者の一意のPerson ID。
• PrimaryContactFlag: boolean
  タイトル: Primary

  担当者がサービス・リクエストのプライマリ担当者かどうかを示します。 はいの場合、値はTrueで、そうでない場合はFalseです。
• RelationTypeCd: string
  タイトル: Relationship Type Code

  最大長: 30

  サービス・リクエストのコンテキストにおける担当者との関係。 たとえば、代替、フォロワ、Third_Partyなどです。
• SrId: integer (int64)
  タイトル: Service Request ID

  関連付けられたサービス・リクエストの一意の識別子。
• SrNumber: string
  タイトル: Service Request Number

  最大長: 30

  サービス・リクエスト番号の代替キー。
• UpdateFlag: boolean
  タイトル: Can Update

  読取り専用: true

  レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "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
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name of the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the service request contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the contact.",
            "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"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service request contact member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the contact as a member of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"Indicates the formatted address of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactIdenAddrLocationId"
                ]
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative key for the contact identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact of the service request doesn't want to be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 of the user who last update the contact's object associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":900,
            "type":"string",
            "description":"The primary account of the service request contact.",
            "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."
        }
    }
}

リンク

AccessLevelLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_ACCESS_LEVEL

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

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

ContactTypeLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_CONTACT_TYPE

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

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

PersonDVO

操作: /crmRestApi/resources/11.13.18.05/contacts

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

• ソース属性: ContactPartyName;ターゲット属性: PartyName
• 表示属性: PartyName, PrimaryEmailAddress

RelationshipTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CONTACT_REL_TYPE_CD

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

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

「トップに戻る」