Jump to

• Request
• Response

Update an interaction data

patch

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionData/{interactions_InteractionData_Id}

Request

Path Parameters

• InteractionId(required): integer(int64)
  The unique identifier of the interaction.
• interactions_InteractionData_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=

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

• DeletedFlag: boolean
  Title: Deleted Flag

  Maximum Length: 1

  Indicates whether the interaction data was deleted.
• InteractionDataId: integer (int64)
  Title: Interaction Data Id

  The unique identifier of the interaction data.
• InteractionId: integer (int64)
  Title: Interaction Id

  Unique identifier of interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The user who last updated the interaction data.
• LastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the interaction data.
• TokenId: integer (int64)
  Title: Token Id

  The unique identifier of the token.
• Value: string
  Title: Data Value

  Maximum Length: 4000

  Value of the token.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "title":"Deleted Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the interaction data was deleted.",
            "nullable":true
        },
        "InteractionDataId":{
            "title":"Interaction Data Id",
            "type":"integer",
            "description":"The unique identifier of the interaction data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InteractionId":{
            "title":"Interaction Id",
            "type":"integer",
            "description":"Unique identifier of interaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction data was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the interaction data.",
            "nullable":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interaction data.",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "TokenId":{
            "title":"Token Id",
            "type":"integer",
            "description":"The unique identifier of the token.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Value":{
            "title":"Data Value",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the token.",
            "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 : interactions-InteractionData-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Maximum Length: 64

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

  The date when the interaction data was created.
• DeletedFlag: boolean
  Title: Deleted Flag

  Maximum Length: 1

  Indicates whether the interaction data was deleted.
• InteractionDataId: integer (int64)
  Title: Interaction Data Id

  The unique identifier of the interaction data.
• InteractionDataNumber: string
  Title: Interaction Data Number

  Maximum Length: 30

  The alternate identifier of the interaction data.
• InteractionId: integer (int64)
  Title: Interaction Id

  Unique identifier of interaction.
• InteractionNumber: string
  Title: Interaction Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The user who last updated the interaction data.
• LastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the interaction data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TokenId: integer (int64)
  Title: Token Id

  The unique identifier of the token.
• Value: string
  Title: Data Value

  Maximum Length: 4000

  Value of the token.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interaction data.",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the interaction data was created.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the interaction data was deleted.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionDataId":{
            "title":"Interaction Data Id",
            "type":"integer",
            "description":"The unique identifier of the interaction data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InteractionDataNumber":{
            "title":"Interaction Data Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the interaction data.",
            "nullable":false,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction Id",
            "type":"integer",
            "description":"Unique identifier of interaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction data was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the interaction data.",
            "nullable":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interaction data.",
            "nullable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "TokenId":{
            "title":"Token Id",
            "type":"integer",
            "description":"The unique identifier of the token.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Data Value",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the token.",
            "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