Jump to

• Request
• Response

Update adaptive search setup details

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch/{Id}

Request

Path Parameters

• Id(required): string
  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=
• Name(required): string
  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:
  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

• Account: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the account has been selected for adaptive search publish.
• Activity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the activity has been selected for adaptive search publish.
• Asset: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.
• Contact: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the contact has been selected for adaptive search publish.
• Lead: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.
• Opportunity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the opportunity has been selected for adaptive search publish.
• Partner: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner has been selected for adaptive search publish.
• PartnerContact: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner contact has been selected for adaptive search publish.
• Product: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product has been selected for the adaptive search publish.
• ProductGroup: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product Group has been selected for the adaptive search publish.
• RevenueLines: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the lead has been selected for adaptive search publish.
• ServiceRequest: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the service request has been selected for adaptive search publish.

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "ProductGroup":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Activity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Product":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "RevenueLines":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "PartnerContact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "ServiceRequest":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Contact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Opportunity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Lead":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y"
        },
        "Asset":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y"
        },
        "Partner":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        }
    }
}

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 : setupAssistants-AdaptiveSearch-item-response

Type: object

Show Source

• Account: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the account has been selected for adaptive search publish.
• Activity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the activity has been selected for adaptive search publish.
• Asset: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.
• Contact: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the contact has been selected for adaptive search publish.
• Id: string
  Maximum Length: 80

  The unique identifier of the adaptive search setup task.
• Lead: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Opportunity: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the opportunity has been selected for adaptive search publish.
• Partner: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner has been selected for adaptive search publish.
• PartnerContact: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the partner contact has been selected for adaptive search publish.
• Product: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product has been selected for the adaptive search publish.
• ProductGroup: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether Product Group has been selected for the adaptive search publish.
• RevenueLines: string
  Maximum Length: 80

  Default Value: Y

  Indicates whether the lead has been selected for adaptive search publish.
• ServiceRequest: string
  Maximum Length: 80

  Default Value: N

  Indicates whether the service request has been selected for adaptive search publish.

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "ProductGroup":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Activity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Product":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "RevenueLines":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "PartnerContact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ServiceRequest":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Contact":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Opportunity":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Lead":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Asset object has been selected for inclusion in the Adaptive Search Publish process. If true, then assets are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Asset":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the Revenue Lines object has been selected for inclusion in the Adaptive Search Publish process. If true, then revenue lines are included in the process. By default, the value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the adaptive search setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Partner":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "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."
        }
    }
}

Back to Top