Create a SmartText history
post
/crmRestApi/resources/11.13.18.05/smartTextHistory
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
-
ObjectReference: string
Title:
Reference
Maximum Length:30
The unique reference to the row in the object for which this SmartText was used. -
ObjectReferenceId: integer
(int64)
The primary key to the row in the object for which this SmartText was used.
-
ObjectUsed: string
Title:
Object
Maximum Length:30
The object for which this SmartText was used. -
StdTxtId: integer
(int64)
Title:
Standard Text ID
The alternate unique identifier of the SmartText. -
TxtLang: string
Title:
Language
Maximum Length:4
The code of the language into which the contents of the translatable columns are translated. -
Type: string
Title:
Type
Maximum Length:10
The type of SmartText used. -
UserPartyId: integer
(int64)
Title:
User ID
The foreign key to the party that used the SmartText.
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 : smartTextHistory-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the SmartText history. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the SmartText history was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the SmartText history was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the SmartText history. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the SmartText history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectReference: string
Title:
Reference
Maximum Length:30
The unique reference to the row in the object for which this SmartText was used. -
ObjectReferenceId: integer
(int64)
The primary key to the row in the object for which this SmartText was used.
-
ObjectUsed: string
Title:
Object
Maximum Length:30
The object for which this SmartText was used. -
PartyName: string
Read Only:
true
Maximum Length:360
The name of the party that used the SmartText. -
StdTxtHistId: integer
(int64)
Title:
Standard Text History ID
Read Only:true
The auto-generated number and primary key for the SmartText history item. -
StdTxtId: integer
(int64)
Title:
Standard Text ID
The alternate unique identifier of the SmartText. -
TxtLang: string
Title:
Language
Maximum Length:4
The code of the language into which the contents of the translatable columns are translated. -
Type: string
Title:
Type
Maximum Length:10
The type of SmartText used. -
UserPartyId: integer
(int64)
Title:
User ID
The foreign key to the party that used the SmartText.
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.