機械翻訳について

ジャンプ先

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

インタビューを見る

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}

リクエスト

パス・パラメータ

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

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• 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
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : leads-Interviews-item-response

タイプ: object

ソースを表示

• AttachmentId: integer (int64)
  タイトル: Attachment ID

  インタビュー要約の添付の識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  インタビュー・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  インタビュー・レコードが作成された日時。
• InterviewData: 文字列(バイト)
  タイトル: Interview Data

  質問リストおよびレスポンスを含む送信済インタビュー・データ。
• InterviewDataLang: string
  タイトル: Interview Data Language

  最大長: 30

  インタビューが送信された言語。
• InterviewDraft: 文字列(バイト)
  タイトル: Interview Draft

  暫定インタビュー・データ。 これにより、ユーザーは保存された下書きから続行できます。
• InterviewId: integer (int64)
  タイトル: Interview ID

  インタビュー・レコードの一意の識別子。
• InterviewName: string
  タイトル: Interview Name

  最大長: 100

  インタビューの名前。
• InterviewNumber: string
  タイトル: Interview Number

  最大長: 30

  インタビュー・レコードの公開一意識別子。
• InterviewStatus: string
  タイトル: Interview Status

  最大長: 30

  インタビューのステータスを指定
• LastUpdateDate: string (date-time)
  タイトル: Last Updated

  読取り専用: true

  インタビュー・レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  インタビュー・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  読取り専用: true

  行が更新された回数を指定します。
• OwnerResourceId: integer (int64)
  タイトル: Owner Resource ID

  レコードを作成したユーザーの一意の識別子。
• OwnerResourceNumber: string
  タイトル: Owner Resource Number

  読取り専用: true

  最大長: 30

  レコードを作成したユーザーの公開一意識別子。
• OwnerResourcePartyName: string
  タイトル: Owner

  読取り専用: true

  最大長: 360

  インタビュー・レコードを作成したユーザーの名前。
• SourceObjectCode: string
  タイトル: Source Object Code

  最大長: 30

  インタビューに関連付けられたトップ・レベル・オブジェクトの名前。
• SourceObjectId: integer (int64)
  タイトル: Source Object ID

  インタビューに関連付けられたトップ・レベル・オブジェクトの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interview record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResourceNumber":{
            "title":"Owner Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InterviewId":{
            "title":"Interview ID",
            "type":"integer",
            "description":"The unique identifier of interview record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterviewName":{
            "title":"Interview Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the interview.",
            "nullable":false,
            "x-queryable":true
        },
        "InterviewDataLang":{
            "title":"Interview Data Language",
            "maxLength":30,
            "type":"string",
            "description":"The language in which interview has been submitted.",
            "nullable":true,
            "x-queryable":false
        },
        "InterviewData":{
            "title":"Interview Data",
            "type":"string",
            "description":"The submitted interview data containing questionnaires and responses.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The identifier for attachment of interview summary.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of top level object associated with the interview.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Specifies how many times the row has been updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The name of the top level object associated with the interview.",
            "nullable":false,
            "x-queryable":true
        },
        "InterviewStatus":{
            "title":"Interview Status",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the status of the interview",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InterviewDraft":{
            "title":"Interview Draft",
            "type":"string",
            "description":"The draft interview data. This allows a user to continue from the saved draft.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterviewNumber":{
            "title":"Interview Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the interview record.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the user who created the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerResourcePartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who created the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date and time when the interview record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

リンク

InterviewStatusLookupPVO

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_INTERVIEW_STATUS

面接レコードの有効なステータスのリスト。

「トップに戻る」