Create a reference
post
/crmRestApi/resources/11.13.18.05/dynamicLinkValues
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
-
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit mapped to Digital Customer Portal. -
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:240
The name of the business unit mapped to Digital Customer Portal. -
CustomerPortalURL: string
Title:
External URL
Maximum Length:1024
The URL to the Digital Customer Portal. -
InternalURL: string
Title:
Internal URL
Maximum Length:1024
The internal URL for opening dynamic links using an internal application of the implementing company. -
ObjectType: string
Title:
Object Type
The object type of dynamic link value. -
ObjectTypeId: integer
(int64)
Title:
Object Type ID
The object type ID of dynamic link value. -
ObjectVersionNumber: integer
(int32)
The object version number of dynamic link value.
-
Pattern: string
Title:
Pattern
The pattern of dynamic link value. -
PatternPrefix: string
Title:
Pattern Beginning
The pattern prefix of dynamic link value. -
PatternSuffix: string
Title:
Pattern Ending
The pattern suffix of dynamic link value.
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 : dynamicLinkValues-item-response
Type:
Show Source
object
-
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit mapped to Digital Customer Portal. -
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:240
The name of the business unit mapped to Digital Customer Portal. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the link record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the link record was created -
CustomerPortalURL: string
Title:
External URL
Maximum Length:1024
The URL to the Digital Customer Portal. -
InternalURL: string
Title:
Internal URL
Maximum Length:1024
The internal URL for opening dynamic links using an internal application of the implementing company. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the link record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the link record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the link record. -
LinkId: integer
(int64)
Title:
Link ID
Read Only:true
The unique identifier of the dynamic link value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectType: string
Title:
Object Type
The object type of dynamic link value. -
ObjectTypeId: integer
(int64)
Title:
Object Type ID
The object type ID of dynamic link value. -
ObjectVersionNumber: integer
(int32)
The object version number of dynamic link value.
-
Pattern: string
Title:
Pattern
The pattern of dynamic link value. -
PatternPrefix: string
Title:
Pattern Beginning
The pattern prefix of dynamic link value. -
PatternSuffix: string
Title:
Pattern Ending
The pattern suffix of dynamic link value.
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.