Create a signature
post
/crmRestApi/resources/11.13.18.05/signatures
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
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.
Root Schema : signatures-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.