Jump to

• Request
• Response

Create a dynamic link pattern

post

/crmRestApi/resources/11.13.18.05/dynamicLinkPatterns

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Label: string
  Maximum Length: 1024

  The display label for the object type, such as Service Request, Knowledge Article, etc.
• ObjectType: string
  Title: Object Type

  Maximum Length: 30

  The type of the object, such as Service Request, Knowledge Article, etc.
• ObjectVersionNumber: integer (int32)
  The internal unique identifier of the table row.
• Pattern: string
  Title: Pattern

  Maximum Length: 1024

  The regular expression used for searching the object in the message content.
• PatternPrefix: string
  Title: Pattern Beginning

  Maximum Length: 512

  The prefix of the pattern, the information before the actual object identifier.
• PatternSuffix: string
  Title: Pattern Ending

  Maximum Length: 512

  The suffix of the pattern, the information after the actual object identifier.

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the object, such as Service Request, Knowledge Article, etc.",
            "nullable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":"1024",
            "type":"string",
            "description":"The regular expression used for searching the object in the message content.",
            "nullable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "maxLength":"512",
            "type":"string",
            "description":"The suffix of the pattern, the information after the actual object identifier.",
            "nullable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "maxLength":"512",
            "type":"string",
            "description":"The prefix of the pattern, the information before the actual object identifier.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The internal unique identifier of the table row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "Label":{
            "maxLength":"1024",
            "type":"string",
            "description":"The display label for the object type, such as Service Request, Knowledge Article, etc.",
            "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 : dynamicLinkPatterns-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the pattern was created.
• Label: string
  Maximum Length: 1024

  The display label for the object type, such as Service Request, Knowledge Article, etc.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  Read Only: true

  The unique identifier of the pattern.
• ObjectType: string
  Title: Object Type

  Maximum Length: 30

  The type of the object, such as Service Request, Knowledge Article, etc.
• ObjectVersionNumber: integer (int32)
  The internal unique identifier of the table row.
• Pattern: string
  Title: Pattern

  Maximum Length: 1024

  The regular expression used for searching the object in the message content.
• PatternPrefix: string
  Title: Pattern Beginning

  Maximum Length: 512

  The prefix of the pattern, the information before the actual object identifier.
• PatternSuffix: string
  Title: Pattern Ending

  Maximum Length: 512

  The suffix of the pattern, the information after the actual object identifier.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the pattern was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":"1024",
            "type":"string",
            "description":"The regular expression used for searching the object in the message content.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "maxLength":"512",
            "type":"string",
            "description":"The suffix of the pattern, the information after the actual object identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the pattern.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Label":{
            "maxLength":"1024",
            "type":"string",
            "description":"The display label for the object type, such as Service Request, Knowledge Article, etc.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the object, such as Service Request, Knowledge Article, etc.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "maxLength":"512",
            "type":"string",
            "description":"The prefix of the pattern, the information before the actual object identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The internal unique identifier of the table row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the pattern was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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