Update a dynamic link pattern
patch
/crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/{ObjectId}
Request
Path Parameters
-
ObjectId(required): integer(int64)
The unique identifier of the pattern.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
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 : dynamicLinkPatterns-item-response
Type:
Show Source
object
-
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.
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.
Examples
The following example shows how to update a dynamic link pattern by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/1
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "ObjectType": "SERVICE_REQUEST_CRM" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ObjectId": 2, "ObjectVersionNumber": 2, "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2018-08-18T04:14:01+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "7572459B45477E7DE0538E09F20A8E5D", "LastUpdateDate": "2018-09-11T09:15:17+00:00", "ObjectType": "SERVICE_REQUEST_CRM", "Pattern": "(?i)\\b(SR)([0-9]{10})\\b", "PatternPrefix": null, "PatternSuffix": null, "Label": null, "links": [ ... ] }