機械翻訳について

ジャンプ先

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

会話の作成

post

/crmRestApi/resources/11.13.18.05/conversations

リクエスト

ヘッダー・パラメータ

• 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

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit ID

  会話に関連付けられているビジネス・ユニット組織の一意の識別子。
• ConversationAlternateId: string
  タイトル: Conversation Alternate ID

  最大長: 255

  会話の代替一意識別子。
• ConversationNumber: string
  タイトル: Conversation Number

  最大長: 30

  会話の代替キー識別子。
• conversationReferences: array Conversation References
  タイトル: Conversation References

  会話参照。
• ConversationStatusCd: string
  タイトル: Conversation Status Code

  最大長: 30

  OPENやCLOSEDなど、会話のステータスを示すコード。
• ConversationTypeCd: string
  タイトル: Conversation Type Code

  最大長: 30

  顧客やコラボレーションなど、会話のタイプを示すコード。
• OriginalSystemReference: string
  タイトル: Original Application Reference

  最大長: 1000

  元のアプリケーションからの会話メッセージの一意の参照キー。
• OriginatedConversationId: integer (int64)
  タイトル: Originated Conversation ID

  現在の会話が作成された元の会話の一意の識別子。
• OriginatedConversationNumber: string
  タイトル: Originating Conversation Number

  最大長: 30

  現在の会話が作成された元の会話の代替キー識別子。
• PrimaryMessageId: integer (int64)
  タイトル: Primary Message ID

  会話のプライマリ・メッセージの一意の識別子。
• PrimaryMessageNumber: string
  タイトル: Primary Message Number

  最大長: 30

  会話のプライマリ・メッセージの代替キー識別子。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。

{
    "type":"object",
    "properties":{
        "PrimaryMessageNumber":{
            "title":"Primary Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the primary message in the conversation.",
            "nullable":false
        },
        "ConversationAlternateId":{
            "title":"Conversation Alternate ID",
            "maxLength":255,
            "type":"string",
            "description":"The alternate unique identifier of the conversation.",
            "nullable":true
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation.",
            "nullable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryMessageId":{
            "title":"Primary Message ID",
            "type":"integer",
            "description":"The unique identifier of the primary message in the conversation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OriginalSystemReference":{
            "title":"Original Application Reference",
            "maxLength":1000,
            "type":"string",
            "description":"A unique reference key of the conversation message from the original application.",
            "nullable":true
        },
        "OriginatedConversationNumber":{
            "title":"Originating Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the original conversation from which the current conversation was created.",
            "nullable":false
        },
        "ConversationStatusCd":{
            "title":"Conversation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the conversation, such as OPEN or CLOSED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit organization associated with the conversation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OriginatedConversationId":{
            "title":"Originated Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the original conversation from which the current conversation was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "conversationReferences":{
            "title":"Conversation References",
            "type":"array",
            "description":"Conversation references.",
            "items":{
                "$ref":"#/components/schemas/conversations-conversationReferences-item-post-request"
            }
        },
        "ConversationTypeCd":{
            "title":"Conversation Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the conversation, such as Customer or Collaboration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : 会話参照

タイプ: array

タイトル: Conversation References

会話参照。

ソースを表示

• Array of: object conversations-conversationReferences-item-post-request

{
    "title":"Conversation References",
    "type":"array",
    "description":"Conversation references.",
    "items":{
        "$ref":"#/components/schemas/conversations-conversationReferences-item-post-request"
    }
}

ネストされたスキーマ : conversations-conversationReferences-item-post-request

タイプ: object

ソースを表示

• ConversationId: integer (int64)
  タイトル: Conversation ID

  ビジネス・オブジェクトが関連付けられている会話の一意の識別子。
• ConversationNumber: string
  タイトル: Conversation Number

  最大長: 30

  ビジネス・オブジェクトが関連付けられている会話の代替キー識別子。
• ObjectId: integer (int64)
  タイトル: Object ID

  会話に関連付けられたビジネス・オブジェクトの一意の識別子。
• ObjectNumber: string
  タイトル: Object Number

  最大長: 255

  会話に関連付けられたビジネス・オブジェクトの代替キー識別子。
• ObjectTypeCd: string
  タイトル: Object Type

  最大長: 30

  会話に関連付けられているビジネス・オブジェクトのタイプを示すコード(SVC_SERVICE_REQUESTSなど)。
• ReferenceNumber: string
  タイトル: Reference Number

  最大長: 30

  会話参照の公開一意識別子。

{
    "type":"object",
    "properties":{
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation with which the business object is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectNumber":{
            "title":"Object Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier of the business object associated with the conversation.",
            "nullable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the business object associated with the conversation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation with which the business object is associated.",
            "nullable":false
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the conversation reference.",
            "nullable":false
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : conversations-item-response

タイプ: object

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit ID

  会話に関連付けられているビジネス・ユニット組織の一意の識別子。
• ConversationAlternateId: string
  タイトル: Conversation Alternate ID

  最大長: 255

  会話の代替一意識別子。
• ConversationId: integer (int64)
  タイトル: Conversation ID

  読取り専用: true

  会話の一意の識別子。
• ConversationNumber: string
  タイトル: Conversation Number

  最大長: 30

  会話の代替キー識別子。
• conversationReferences: array Conversation References
  タイトル: Conversation References

  会話参照。
• ConversationSortDate: string (date-time)
  タイトル: Conversation Sort Date

  読取り専用: true

  会話をソートするために使用できる日付フィールド。 現在は、会話のメッセージが更新された最新の日付です。
• ConversationStatusCd: string
  タイトル: Conversation Status Code

  最大長: 30

  OPENやCLOSEDなど、会話のステータスを示すコード。
• ConversationStatusCdMeaning: string
  タイトル: Conversation Status

  読取り専用: true

  最大長: 255

  会話のステータス(オープンやクローズ済など)。
• ConversationTypeCd: string
  タイトル: Conversation Type Code

  最大長: 30

  顧客やコラボレーションなど、会話のタイプを示すコード。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  会話を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation 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

  リソース・インスタンスに関連付けられたリンク関係。
• OriginalSystemReference: string
  タイトル: Original Application Reference

  最大長: 1000

  元のアプリケーションからの会話メッセージの一意の参照キー。
• OriginatedConversationId: integer (int64)
  タイトル: Originated Conversation ID

  現在の会話が作成された元の会話の一意の識別子。
• OriginatedConversationNumber: string
  タイトル: Originating Conversation Number

  最大長: 30

  現在の会話が作成された元の会話の代替キー識別子。
• PrimaryMessageId: integer (int64)
  タイトル: Primary Message ID

  会話のプライマリ・メッセージの一意の識別子。
• PrimaryMessageNumber: string
  タイトル: Primary Message Number

  最大長: 30

  会話のプライマリ・メッセージの代替キー識別子。
• PrimaryMessageTitle: string
  タイトル: Subject

  読取り専用: true

  最大長: 1000

  会話に関連付けられているプライマリ・メッセージのタイトル。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the conversation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the conversation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationSortDate":{
            "title":"Conversation Sort Date",
            "type":"string",
            "description":"The date field using which the conversation can be sorted. Currently it's the latest date when a message in the conversation was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the conversation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryMessageTitle":{
            "title":"Subject",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the primary message associated with the conversation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryMessageId":{
            "title":"Primary Message ID",
            "type":"integer",
            "description":"The unique identifier of the primary message in the conversation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original Application Reference",
            "maxLength":1000,
            "type":"string",
            "description":"A unique reference key of the conversation message from the original application.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversationStatusCd":{
            "title":"Conversation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the conversation, such as OPEN or CLOSED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "conversationReferences":{
            "title":"Conversation References",
            "type":"array",
            "description":"Conversation references.",
            "items":{
                "$ref":"#/components/schemas/conversations-conversationReferences-item-response"
            }
        },
        "ConversationTypeCd":{
            "title":"Conversation Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the conversation, such as Customer or Collaboration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryMessageNumber":{
            "title":"Primary Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the primary message in the conversation.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversationAlternateId":{
            "title":"Conversation Alternate ID",
            "maxLength":255,
            "type":"string",
            "description":"The alternate unique identifier of the conversation.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConversationStatusCdMeaning":{
            "title":"Conversation Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the conversation, such as Open or Closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ConversationStatusCd"
                ]
            },
            "x-queryable":true
        },
        "OriginatedConversationNumber":{
            "title":"Originating Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the original conversation from which the current conversation was created.",
            "nullable":false,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit organization associated with the conversation.",
            "format":"int64",
            "nullable":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"
            }
        },
        "OriginatedConversationId":{
            "title":"Originated Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the original conversation from which the current conversation was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the conversation 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 conversation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 会話参照

タイプ: array

タイトル: Conversation References

会話参照。

ソースを表示

• Array of: object conversations-conversationReferences-item-response

{
    "title":"Conversation References",
    "type":"array",
    "description":"Conversation references.",
    "items":{
        "$ref":"#/components/schemas/conversations-conversationReferences-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"
    }
}

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

タイプ: object

ソースを表示

• ConversationId: integer (int64)
  タイトル: Conversation ID

  ビジネス・オブジェクトが関連付けられている会話の一意の識別子。
• ConversationNumber: string
  タイトル: Conversation Number

  最大長: 30

  ビジネス・オブジェクトが関連付けられている会話の代替キー識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  会話参照を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation 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

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

  会話に関連付けられたビジネス・オブジェクトの一意の識別子。
• ObjectNumber: string
  タイトル: Object Number

  最大長: 255

  会話に関連付けられたビジネス・オブジェクトの代替キー識別子。
• ObjectTypeCd: string
  タイトル: Object Type

  最大長: 30

  会話に関連付けられているビジネス・オブジェクトのタイプを示すコード(SVC_SERVICE_REQUESTSなど)。
• ObjectTypeCdMeaning: string
  タイトル: Object Type

  読取り専用: true

  最大長: 255

  商談、サービス・リクエスト、アクティビティ、営業リードまたはアカウントなどのオブジェクト・タイプ。
• ReferenceId: integer (int64)
  タイトル: Reference ID

  読取り専用: true

  会話参照の一意の識別子。
• ReferenceNumber: string
  タイトル: Reference Number

  最大長: 30

  会話参照の公開一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the conversation reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the conversation reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation with which the business object is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the conversation reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Object Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier of the business object associated with the conversation.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the business object associated with the conversation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the conversation reference.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCdMeaning":{
            "title":"Object Type",
            "maxLength":255,
            "type":"string",
            "description":"The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ObjectTypeCd"
                ]
            },
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the conversation reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation with which the business object is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the conversation reference 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 conversation reference.",
            "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."
        }
    }
}

リンク

ConversationStatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

ConversationTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

StripeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

conversationReferences

操作: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences

パラメータ:

• ConversationNumber: $request.path.ConversationNumber

会話参照。

「トップに戻る」