機械翻訳について

ジャンプ先

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

サーベイ・リクエストの更新

patch

/crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ObjectId: integer (int64)
  タイトル: Survey Request Object ID

  サーベイが割り当てられるオブジェクトの識別子。 サービス・リクエストIDの例。
• ObjectTypeCd: string
  タイトル: Survey Request Object Type Code

  最大長: 30

  サーベイが割り当てられるオブジェクトのタイプ。 サービス・リクエスト、取引先の例。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・リクエストのバージョン番号。
• OwnerId: integer (int64)
  タイトル: Owner ID

  サーベイ・レスポンスを所有する個人。
• PartyId: integer (int64)
  タイトル: Survey Request Party ID

  サーベイを受信する担当者の識別子。
• RespondedFlag: boolean
  タイトル: Survey Request Response Indicator

  最大長: 1

  サーベイが回答済かどうかを示すインジケータ。
• ResponseDate: string (date-time)
  タイトル: Response Date

  サーベイが回答された日付。
• responses: array Survey Responses
  タイトル: Survey Responses

  レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
• VendorRequestId: string
  タイトル: Survey Product Request ID

  最大長: 64

  外部サーベイ製品リクエストのキー識別子。

{
    "type":"object",
    "properties":{
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when survey was answered.",
            "format":"date-time",
            "nullable":true
        },
        "PartyId":{
            "title":"Survey Request Party ID",
            "type":"integer",
            "description":"The identifier of the contact who will receive the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectId":{
            "title":"Survey Request Object ID",
            "type":"integer",
            "description":"The identifier of the object for which the survey will be assigned. Example Service Request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey request.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false
        },
        "ObjectTypeCd":{
            "title":"Survey Request Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object for which the survey will be assigned. Example Service Request, Account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "responses":{
            "title":"Survey Responses",
            "type":"array",
            "description":"The response resource is used to view and update the survey responses.",
            "items":{
                "$ref":"#/components/schemas/surveyRequests-responses-item-patch-request"
            }
        }
    }
}

ネストされたスキーマ : サーベイ・レスポンス

タイプ: array

タイトル: Survey Responses

レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。

ソースを表示

• Array of: object surveyRequests-responses-item-patch-request

{
    "title":"Survey Responses",
    "type":"array",
    "description":"The response resource is used to view and update the survey responses.",
    "items":{
        "$ref":"#/components/schemas/surveyRequests-responses-item-patch-request"
    }
}

ネストされたスキーマ : surveyRequests-responses-item-patch-request

タイプ: object

ソースを表示

• AnswerId: integer (int64)
  タイトル: Survey Answer ID

  回答選択のキー識別子。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・レスポンスのバージョン番号。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  このレスポンスの質問の質問識別番号。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  このレスポンスのサーベイ・リクエスト識別番号。
• テキスト: 文字列(バイト)
  タイトル: Survey Response Text

  サーベイに含まれるテキスト・レスポンス。

{
    "type":"object",
    "properties":{
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true
        },
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The survey request identification number for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The question identification number of the question for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey response.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• 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)
  タイトル: Survey Request Object ID

  サーベイが割り当てられるオブジェクトの識別子。 サービス・リクエストIDの例。
• ObjectTypeCd: string
  タイトル: Survey Request Object Type Code

  最大長: 30

  サーベイが割り当てられるオブジェクトのタイプ。 サービス・リクエスト、取引先の例。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・リクエストのバージョン番号。
• OwnerId: integer (int64)
  タイトル: Owner ID

  サーベイ・レスポンスを所有する個人。
• PartyId: integer (int64)
  タイトル: Survey Request Party ID

  サーベイを受信する担当者の識別子。
• RespondedFlag: boolean
  タイトル: Survey Request Response Indicator

  最大長: 1

  サーベイが回答済かどうかを示すインジケータ。
• ResponseDate: string (date-time)
  タイトル: Response Date

  サーベイが回答された日付。
• responses: array Survey Responses
  タイトル: Survey Responses

  レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
• SurveyId: integer (int64)
  タイトル: Survey ID

  サーベイのキー識別子。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  読取り専用: true

  サーベイ・リクエストのキー識別子。
• SurveyTemplateName: string
  タイトル: Survey Template Name

  読取り専用: true

  最大長: 400

  サーベイ・リクエストに関連付けられたサーベイ・テンプレートの名前。
• VendorRequestId: string
  タイトル: Survey Product Request ID

  最大長: 64

  外部サーベイ製品リクエストのキー識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey request 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 the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when survey was answered.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The key identifier of the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Survey Request Object ID",
            "type":"integer",
            "description":"The identifier of the object for which the survey will be assigned. Example Service Request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The key identifier of the survey request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyTemplateName":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey template associated with the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Survey Request Party ID",
            "type":"integer",
            "description":"The identifier of the contact who will receive the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey request.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Survey Request Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object for which the survey will be assigned. Example Service Request, Account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "responses":{
            "title":"Survey Responses",
            "type":"array",
            "description":"The response resource is used to view and update the survey responses.",
            "items":{
                "$ref":"#/components/schemas/surveyRequests-responses-item-response"
            }
        },
        "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 the survey request 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 survey request.",
            "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"
    }
}

ネストされたスキーマ : サーベイ・レスポンス

タイプ: array

タイトル: Survey Responses

レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。

ソースを表示

• Array of: object surveyRequests-responses-item-response

{
    "title":"Survey Responses",
    "type":"array",
    "description":"The response resource is used to view and update the survey responses.",
    "items":{
        "$ref":"#/components/schemas/surveyRequests-responses-item-response"
    }
}

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

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

ネストされたスキーマ : surveyRequests-responses-item-response

タイプ: object

ソースを表示

• Answer: string
  タイトル: Survey Answer Text

  読取り専用: true

  最大長: 4000

  このサーベイ・レスポンスの回答。
• AnswerId: integer (int64)
  タイトル: Survey Answer ID

  回答選択のキー識別子。
• 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

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

  サーベイ・レスポンスのバージョン番号。
• Question: string
  タイトル: Survey Question Text

  読取り専用: true

  最大長: 4000

  このサーベイ・レスポンスの質問。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  このレスポンスの質問の質問識別番号。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  このレスポンスのサーベイ・リクエスト識別番号。
• SurveyResponseId: integer (int64)
  タイトル: Survey Response ID

  読取り専用: true

  サーベイ・レスポンスの識別番号。
• テキスト: 文字列(バイト)
  タイトル: Survey Response Text

  サーベイに含まれるテキスト・レスポンス。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey response 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 the survey responses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SurveyResponseId":{
            "title":"Survey Response ID",
            "type":"integer",
            "description":"The identification number of a survey response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The survey request identification number for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Answer":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The answer for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The question identification number of the question for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey response.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Question":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The question for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey response 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 survey response.",
            "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"
    }
}

リンク

ObjectTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

レスポンス

操作: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses

パラメータ:

• SurveyRequestId: $request.path.SurveyRequestId

レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。

「トップに戻る」