Jump to

• Request
• Response

Update a reference

patch

/crmRestApi/resources/11.13.18.05/dynamicLinkValues/{dynamicLinkValuesUniqID}

Request

Path Parameters

• dynamicLinkValuesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Dynamic Link Values resource and used to uniquely identify an instance of Dynamic Link Values. The client should not generate the hash key value. Instead, the client should query on the Dynamic Link Values collection resource in order to navigate to a specific instance of Dynamic Link Values to get the hash key.

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

• 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.

{
    "type":"object",
    "properties":{
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit mapped to Digital Customer Portal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit mapped to Digital Customer Portal.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CustomerPortalURL":{
            "title":"External URL",
            "maxLength":1024,
            "type":"string",
            "description":"The URL to the Digital Customer Portal.",
            "nullable":true
        },
        "InternalURL":{
            "title":"Internal URL",
            "maxLength":1024,
            "type":"string",
            "description":"The internal URL for opening dynamic links using an internal application of the implementing company.",
            "nullable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "type":"string",
            "description":"The object type of dynamic link value.",
            "nullable":true
        },
        "ObjectTypeId":{
            "title":"Object Type ID",
            "type":"integer",
            "description":"The object type ID of dynamic link value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of dynamic link value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Pattern":{
            "title":"Pattern",
            "type":"string",
            "description":"The pattern of dynamic link value.",
            "nullable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "type":"string",
            "description":"The pattern prefix of dynamic link value.",
            "nullable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "type":"string",
            "description":"The pattern suffix of dynamic link value.",
            "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 : dynamicLinkValues-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit mapped to Digital Customer Portal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit mapped to Digital Customer Portal.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the link record was created",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPortalURL":{
            "title":"External URL",
            "maxLength":1024,
            "type":"string",
            "description":"The URL to the Digital Customer Portal.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalURL":{
            "title":"Internal URL",
            "maxLength":1024,
            "type":"string",
            "description":"The internal URL for opening dynamic links using an internal application of the implementing company.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the link record 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 details of the user who last updated the link record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkId":{
            "title":"Link ID",
            "type":"integer",
            "description":"The unique identifier of the dynamic link value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "type":"string",
            "description":"The object type of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeId":{
            "title":"Object Type ID",
            "type":"integer",
            "description":"The object type ID of dynamic link value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of dynamic link value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "type":"string",
            "description":"The pattern of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "type":"string",
            "description":"The pattern prefix of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "type":"string",
            "description":"The pattern suffix of dynamic link value.",
            "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