Jump to

• Request
• Response

Update a signature

patch

/crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}

Request

Path Parameters

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

• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated to a signature.
• DefaultFlag: boolean
  Title: Default Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether the signature is the default signature.
• SignatureContent: string (byte)
  Title: Signature Content

  The content of the signature.
• SignatureName: string
  Title: Signature Name

  Maximum Length: 50

  The name of the signature.
• UserPartyId: integer (int64)
  Title: User Party ID

  The unique party identifier of the user who associated to a signature.

{
    "type":"object",
    "properties":{
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated to a signature.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultFlag":{
            "title":"Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the signature is the default signature.",
            "nullable":false,
            "default":true
        },
        "SignatureContent":{
            "title":"Signature Content",
            "type":"string",
            "description":"The content of the signature.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SignatureName":{
            "title":"Signature Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the signature.",
            "nullable":false
        },
        "UserPartyId":{
            "title":"User Party ID",
            "type":"integer",
            "description":"The unique party identifier of the user who associated to a signature.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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 : signatures-item-response

Type: object

Show Source

• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated to a signature.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the signature record was created.
• DefaultFlag: boolean
  Title: Default Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether the signature is the default signature.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• SignatureContent: string (byte)
  Title: Signature Content

  The content of the signature.
• SignatureId: integer (int64)
  Title: Signature ID

  Read Only: true

  The unique identifier of the signature.
• SignatureName: string
  Title: Signature Name

  Maximum Length: 50

  The name of the signature.
• SignatureNumber: string
  Title: Signature Number

  Maximum Length: 30

  The alternate key identifier of the signature.
• UserPartyId: integer (int64)
  Title: User Party ID

  The unique party identifier of the user who associated to a signature.

{
    "type":"object",
    "properties":{
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated to a signature.",
            "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 signature.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the signature record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultFlag":{
            "title":"Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the signature is the default signature.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the signature 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 signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the signature.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SignatureContent":{
            "title":"Signature Content",
            "type":"string",
            "description":"The content of the signature.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SignatureId":{
            "title":"Signature ID",
            "type":"integer",
            "description":"The unique identifier of the signature.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SignatureName":{
            "title":"Signature Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the signature.",
            "nullable":false,
            "x-queryable":true
        },
        "SignatureNumber":{
            "title":"Signature Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the signature.",
            "nullable":false,
            "x-queryable":true
        },
        "UserPartyId":{
            "title":"User Party ID",
            "type":"integer",
            "description":"The unique party identifier of the user who associated to a signature.",
            "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"
            }
        }
    }
}

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