Jump to

• Request
• Response

Update a survey request

patch

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

Request

Path Parameters

• SurveyRequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InterviewNumber: string
  Title: Interview Number

  The interview number derived from the parent survey's VendorSurveyId.
• ObjectId: integer (int64)
  Title: Survey Request Object ID

  The identifier of the object for which the survey will be assigned. Example Service Request ID.
• ObjectTypeCd: string
  Title: Survey Request Object Type Code

  Maximum Length: 30

  The type of the object for which the survey will be assigned. Example Service Request, Account.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey request.
• OwnerId: integer (int64)
  Title: Owner ID

  The person who owns the survey responses.
• PartyId: integer (int64)
  Title: Survey Request Party ID

  The identifier of the contact who will receive the survey.
• RespondedFlag: boolean
  Title: Survey Request Response Indicator

  Maximum Length: 1

  The indicator that indicates whether survey is answered.
• ResponseDate: string (date-time)
  Title: Response Date

  The date when survey was answered.
• responses: array Survey Responses
  Title: Survey Responses

  The response resource is used to view and update the survey responses.
• VendorRequestId: string
  Title: Survey Product Request ID

  Maximum Length: 64

  The key identifier of the external survey product request.

{
    "type":"object",
    "properties":{
        "InterviewNumber":{
            "title":"Interview Number",
            "type":"string",
            "description":"The interview number derived from the parent survey's VendorSurveyId.",
            "nullable":true,
            "x-queryable":false
        },
        "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
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when survey was answered.",
            "format":"date-time",
            "nullable":true
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false
        },
        "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"
            }
        }
    }
}

Nested Schema : Survey Responses

Type: array

Title: Survey Responses

The response resource is used to view and update the survey responses.

Show Source

• 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"
    }
}

Nested Schema : surveyRequests-responses-item-patch-request

Type: object

Show Source

• AnswerId: integer (int64)
  Title: Survey Answer ID

  The key identifier of the answer choice.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey response.
• QuestionId: integer (int64)
  Title: Survey Question ID

  The question identification number of the question for this response.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  The survey request identification number for this response.
• Text: string (byte)
  Title: Survey Response Text

  The text response included in the survey.

{
    "type":"object",
    "properties":{
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "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
            }
        },
        "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
            }
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The survey request identification number for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : surveyRequests-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey request was created.
• InterviewNumber: string
  Title: Interview Number

  The interview number derived from the parent survey's VendorSurveyId.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey request was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey request.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Survey Request Object ID

  The identifier of the object for which the survey will be assigned. Example Service Request ID.
• ObjectTypeCd: string
  Title: Survey Request Object Type Code

  Maximum Length: 30

  The type of the object for which the survey will be assigned. Example Service Request, Account.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey request.
• OwnerId: integer (int64)
  Title: Owner ID

  The person who owns the survey responses.
• PartyId: integer (int64)
  Title: Survey Request Party ID

  The identifier of the contact who will receive the survey.
• RespondedFlag: boolean
  Title: Survey Request Response Indicator

  Maximum Length: 1

  The indicator that indicates whether survey is answered.
• ResponseDate: string (date-time)
  Title: Response Date

  The date when survey was answered.
• responses: array Survey Responses
  Title: Survey Responses

  The response resource is used to view and update the survey responses.
• SurveyId: integer (int64)
  Title: Survey ID

  The key identifier of the survey.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  Read Only: true

  The key identifier of the survey request.
• SurveyTemplateName: string
  Title: Survey Template Name

  Read Only: true

  Maximum Length: 400

  The name of the survey template associated with the survey request.
• VendorRequestId: string
  Title: Survey Product Request ID

  Maximum Length: 64

  The key identifier of the external survey product request.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "InterviewNumber":{
            "title":"Interview Number",
            "type":"string",
            "description":"The interview number derived from the parent survey's VendorSurveyId.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "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
        },
        "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
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Survey Responses

Type: array

Title: Survey Responses

The response resource is used to view and update the survey responses.

Show Source

• 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"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : surveyRequests-responses-item-response

Type: object

Show Source

• Answer: string
  Title: Survey Answer Text

  Read Only: true

  Maximum Length: 4000

  The answer for this survey response.
• AnswerId: integer (int64)
  Title: Survey Answer ID

  The key identifier of the answer choice.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey responses.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey response was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey response was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey response.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey response.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey response.
• Question: string
  Title: Survey Question Text

  Read Only: true

  Maximum Length: 4000

  The question for this survey response.
• QuestionId: integer (int64)
  Title: Survey Question ID

  The question identification number of the question for this response.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  The survey request identification number for this response.
• SurveyResponseId: integer (int64)
  Title: Survey Response ID

  Read Only: true

  The identification number of a survey response.
• Text: string (byte)
  Title: Survey Response Text

  The text response included in the survey.

{
    "type":"object",
    "properties":{
        "Answer":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The answer for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey responses.",
            "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
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "Question":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The question 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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ObjectTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_OBJECT_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

responses

Operation: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses

Parameters:

• SurveyRequestId: $request.path.SurveyRequestId

The response resource is used to view and update the survey responses.

Back to Top