Jump to

• Request
• Response

Update a similarity configuration

patch

/crmRestApi/resources/11.13.18.05/similarityConfigurations/{ConfigId}

Request

Path Parameters

• ConfigId(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

• ConfigShortName: string
  Title: Configuration Short Name

  Maximum Length: 50

  The short name of the similarity configuration.
• FirstDateConfigColumn: string (date-time)
  Title: Date Configuration Column

  The date-specific configuration for the similarity configuration.
• FirstNumericConfigColumn: integer (int64)
  Title: Numeric Configuration Column

  The numeric-specific configuration associated with the similarity configuration.
• FirstTextConfigColumn: string
  Title: First Text Configuration Column

  Maximum Length: 4000

  The configuration for the Similarity feature including a combination of fields and their values.
• ObjectVersionNumber: integer (int32)
  The object version number for the similar configuration record.
• SecondTextConfigColumn: string
  Title: Second Text Configuration Column

  Maximum Length: 4000

  The second text configuration field used to store the configuration, in case the first field isn't enough.
• ThirdTextConfigColumn: string
  Title: Third Text Configuration Column

  Maximum Length: 4000

  The third text configuration field used to store the configuration, in case the first field and the second fields aren't enough.

{
    "type":"object",
    "properties":{
        "ConfigShortName":{
            "title":"Configuration Short Name",
            "maxLength":50,
            "type":"string",
            "description":"The short name of the similarity configuration.",
            "nullable":false
        },
        "FirstDateConfigColumn":{
            "title":"Date Configuration Column",
            "type":"string",
            "description":"The date-specific configuration for the similarity configuration.",
            "format":"date-time",
            "nullable":true
        },
        "FirstNumericConfigColumn":{
            "title":"Numeric Configuration Column",
            "type":"integer",
            "description":"The numeric-specific configuration associated with the similarity configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FirstTextConfigColumn":{
            "title":"First Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The configuration for the Similarity feature including a combination of fields and their values.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the similar configuration record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SecondTextConfigColumn":{
            "title":"Second Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The second text configuration field used to store the configuration, in case the first field isn't enough.",
            "nullable":true
        },
        "ThirdTextConfigColumn":{
            "title":"Third Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The third text configuration field used to store the configuration, in case the first field and the second fields aren't enough.",
            "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 : similarityConfigurations-item-response

Type: object

Show Source

• ConfigId: integer (int64)
  Title: Configuration Identifier

  Read Only: true

  The unique identifier of the similarity configuration.
• ConfigShortName: string
  Title: Configuration Short Name

  Maximum Length: 50

  The short name of the similarity configuration.
• ConfigType: string
  Title: Configuration Type

  Read Only: true

  Maximum Length: 30

  The type of the similarity configuration. This is specific to the similarity feature and depends on the feature or project.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the similarity configuration was created.
• FirstDateConfigColumn: string (date-time)
  Title: Date Configuration Column

  The date-specific configuration for the similarity configuration.
• FirstNumericConfigColumn: integer (int64)
  Title: Numeric Configuration Column

  The numeric-specific configuration associated with the similarity configuration.
• FirstTextConfigColumn: string
  Title: First Text Configuration Column

  Maximum Length: 4000

  The configuration for the Similarity feature including a combination of fields and their values.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the similarity configuration was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the similarity configuration.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the similarity configuration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number for the similar configuration record.
• SecondTextConfigColumn: string
  Title: Second Text Configuration Column

  Maximum Length: 4000

  The second text configuration field used to store the configuration, in case the first field isn't enough.
• ThirdTextConfigColumn: string
  Title: Third Text Configuration Column

  Maximum Length: 4000

  The third text configuration field used to store the configuration, in case the first field and the second fields aren't enough.

{
    "type":"object",
    "properties":{
        "ConfigId":{
            "title":"Configuration Identifier",
            "type":"integer",
            "description":"The unique identifier of the similarity configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigShortName":{
            "title":"Configuration Short Name",
            "maxLength":50,
            "type":"string",
            "description":"The short name of the similarity configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfigType":{
            "title":"Configuration Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the similarity configuration. This is specific to the similarity feature and depends on the feature or project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the similarity configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the similarity configuration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstDateConfigColumn":{
            "title":"Date Configuration Column",
            "type":"string",
            "description":"The date-specific configuration for the similarity configuration.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FirstNumericConfigColumn":{
            "title":"Numeric Configuration Column",
            "type":"integer",
            "description":"The numeric-specific configuration associated with the similarity configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstTextConfigColumn":{
            "title":"First Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The configuration for the Similarity feature including a combination of fields and their values.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the similarity configuration 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 of the user who last updated the similarity configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the similarity configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the similar configuration record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SecondTextConfigColumn":{
            "title":"Second Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The second text configuration field used to store the configuration, in case the first field isn't enough.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdTextConfigColumn":{
            "title":"Third Text Configuration Column",
            "maxLength":4000,
            "type":"string",
            "description":"The third text configuration field used to store the configuration, in case the first field and the second fields aren't enough.",
            "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"
    }
}

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