Jump to

• Request
• Response
• Examples

Update a lead qualification

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}

Request

Path Parameters

• AssessmentId(required): integer(int64)
  The unique identifier of a lead qualification.
• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssessAnswerGroups: array Assessment Answer Groups
  Title: Assessment Answer Groups

  The assessment answer groups resource is used to view question groups in an assessment.
• AssessedLanguage: string
  Title: Assessment Language

  Maximum Length: 4

  Default Value: US

  The language used for qualification of the lead.
• AssessedObjectId: integer (int64)
  Title: Assessed Object ID

  The unique identifier of the assessed business object.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of a lead qualification.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• Name: string
  Title: Name

  Maximum Length: 255

  The name of the lead qualification.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INCOMPLETE

  The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.
• TotalAnswered: number
  Title: Total Questions Answered

  The number of questions responded in the qualification.
• TotalQuestions: number
  Title: Total Questions

  The total number of questions to be answered in the qualification.

{
    "type":"object",
    "properties":{
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US"
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-patch-request"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        }
    }
}

Nested Schema : Assessment Answer Groups

Type: array

Title: Assessment Answer Groups

The assessment answer groups resource is used to view question groups in an assessment.

Show Source

• Array of: object leads-Assessments-AssessAnswerGroups-item-patch-request

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-patch-request"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-item-patch-request

Type: object

Show Source

• AssessAnswerGroupId: integer (int64)
  The unique identifier of the answer group.
• AssessmentAnswer: array AssessmentAnswer
• AssessmentId: integer (int64)
  The unique identifier of the lead qualification template associated with answer group.

{
    "type":"object",
    "properties":{
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentAnswer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
            }
        }
    }
}

Nested Schema : AssessmentAnswer

Type: array

Show Source

• Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the qualification answer.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The comments entered by the user about the qualification runtime.
• HasComments: string
  Indicates if the comments are present or not.

{
    "type":"object",
    "properties":{
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            }
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

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 : leads-Assessments-item-response

Type: object

Show Source

• AssessAnswerGroups: array Assessment Answer Groups
  Title: Assessment Answer Groups

  The assessment answer groups resource is used to view question groups in an assessment.
• AssessedLanguage: string
  Title: Assessment Language

  Maximum Length: 4

  Default Value: US

  The language used for qualification of the lead.
• AssessedObjectId: integer (int64)
  Title: Assessed Object ID

  The unique identifier of the assessed business object.
• AssessedObjTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The code indicating the type of assessed business object.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of a lead qualification.
• AssessmentScore: integer (int64)
  Title: Score

  Default Value: 0

  The calculated score of the lead qualification.
• AssessTemplateId: integer (int64)
  Title: Template Name

  The unique identifier of the lead qualification template that served as the source of this qualification.
• BusinessUnit: integer (int64)
  Title: Business Unit

  The business unit required to create a lead qualification and corresponds to the business unit of business object.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the lead qualification template record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the lead qualification template record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the lead qualification template record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 255

  The name of the lead qualification.
• RatingFeedback: string
  Title: Feedback

  Read Only: true

  The feedback mapped to the rating of the lead.
• RatingTerm: string
  Title: Rating

  Read Only: true

  The overall rating of the qualification as configured in the associated lead qualification template.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INCOMPLETE

  The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.
• StatusFuse: string
  Title: Status

  Read Only: true

  The status of the qualification.
• TemplateName: string
  Title: Template

  The name of the lead qualification template.
• TemplateType: string
  Title: Template Type

  The object type of the lead qualification template associated with the qualification.
• TotalAnswered: number
  Title: Total Questions Answered

  The number of questions responded in the qualification.
• TotalQuestions: number
  Title: Total Questions

  The total number of questions to be answered in the qualification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusFuse":{
            "title":"Status",
            "type":"string",
            "description":"The status of the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode",
                    "TotalAnswered",
                    "TotalQuestions"
                ]
            },
            "x-queryable":true
        },
        "RatingFeedback":{
            "title":"Feedback",
            "type":"string",
            "description":"The feedback mapped to the rating of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of assessed business object.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US",
            "x-queryable":true
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The object type of the lead qualification template associated with the qualification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of the lead qualification.",
            "format":"int64",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISNOTBLANK"
                ],
                "precision":"10"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-response"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit required to create a lead qualification and corresponds to the business unit of business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template",
            "type":"string",
            "description":"The name of the lead qualification template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RatingTerm":{
            "title":"Rating",
            "type":"string",
            "description":"The overall rating of the qualification as configured in the associated lead qualification template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the lead qualification template that served as the source of this qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the lead qualification template record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Assessment Answer Groups

Type: array

Title: Assessment Answer Groups

The assessment answer groups resource is used to view question groups in an assessment.

Show Source

• Array of: object leads-Assessments-AssessAnswerGroups-item-response

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-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 : leads-Assessments-AssessAnswerGroups-item-response

Type: object

Show Source

• AssessAnswerGroupId: integer (int64)
  The unique identifier of the answer group.
• AssessmentAnswer: array Assessment Answers
  Title: Assessment Answers

  The assessment answer resource is used to view and update a response for a question in a question group.
• AssessmentId: integer (int64)
  The unique identifier of the lead qualification template associated with answer group.
• AttributeGroupId: integer (int64)
  The unique identifier of the question group of the associated lead qualification template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  The name of the answer group.

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated lead qualification template.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the answer group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentAnswer":{
            "title":"Assessment Answers",
            "type":"array",
            "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

Nested Schema : Assessment Answers

Type: array

Title: Assessment Answers

The assessment answer resource is used to view and update a response for a question in a question group.

Show Source

• Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-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 : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the qualification answer.
• AssessmentId: integer (int64)
  The unique identifier of the lead qualification template associated with answer.
• AttributeGroupId: integer (int64)
  Title: Question Group

  The unique identifier of the question group associated with the qualification answer.
• AttributeId: integer (int64)
  Title: Question

  The unique identifier of the question associated with the qualification answer.
• AttributeName: string
  Read Only: true

  Maximum Length: 500

  The name of the question.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The comments entered by the user about the qualification runtime.
• HasComments: string
  Indicates if the comments are present or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseValue: string
  Title: Response

  Read Only: true

  The response of the question.

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            },
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response",
            "type":"string",
            "description":"The response of the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":"500",
            "type":"string",
            "description":"The name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            },
            "x-queryable":true
        }
    }
}

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

Links

AssessAnswerGroups

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups

Parameters:

• AssessmentId: $request.path.AssessmentId
• leadsUniqID: $request.path.leadsUniqID

The assessment answer groups resource is used to view question groups in an assessment.

AssessmentTemplateVA

Operation: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV

Parameters:

• finder: AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}

The assessment templates resource is used to view the assessment templates. It stores the templates associated with assessments.

LookupPVO1

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to update a lead qualification by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"Name": "Lead Qualification for CMS Server V2"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"AssessmentId": 300100104003366,
"BusinessUnit": null,
"AssessTemplateId": 300100104003343,
"Name": "Lead Qualification for CMS Server V2",
"AssessedLanguage": "US",
"StatusCode": "INCOMPLETE",
"AssessmentScore": 0,
"AssessedObjectId": 300100097576277,
"AssessedObjTypeCode": "LEAD",
"LastUpdateDate": "2017-03-28T06:11:50-07:00",
"CreatedBy": "MHoope",
"LastUpdatedBy": "MHoope",
"TemplateName": "Lead Qualification for CMS Server",
"TemplateType": "LEAD",
"TotalQuestions": 5,
"TotalAnswered": 0,
"StatusFuse": "FUSE_STATUS_NOT_STARTED",
"RatingTerm": "Poor",
"RatingFeedback": "The lead is unlikely to be qualified",
"links": [
  {
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366",
"name": "Assessments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
}
},
  {
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366",
"name": "Assessments",
"kind": "item"
},
  {
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277",
"name": "leads",
"kind": "item"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/CommonObjectsMappingPVO1",
"name": "CommonObjectsMappingPVO1",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/AssessmentTemplateVA",
"name": "AssessmentTemplateVA",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/LookupPVO1",
"name": "LookupPVO1",
"kind": "collection"
},
  {
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/child/AssessAnswerGroups",
"name": "AssessAnswerGroups",
"kind": "collection"
}
],
}

Back to Top