Update a link template
patch
/crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}
Request
Path Parameters
-
LinkTemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates if link template for the link is active. -
AssignmentConstraintCd: string
Title:
Assignment Constraints Code
Maximum Length:30
The code that identifies the assignment constraint set on the link template. -
LinkTemplateCatCd: string
Title:
Link Template Category Code
Maximum Length:30
The code that identifies template category selected for this link template. -
LinkTypeLabelFirst: string
Title:
Link Label for First Work Order
Maximum Length:160
The link type label that identifies the link for the first work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeLabelSecond: string
Title:
Link Label for Second Work Order
Maximum Length:160
The link type label that identifies the link for the second work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Maximum Length:256
The link type name that identifies the link for the second work order. -
MaximumIntervalMinutes: integer
(int32)
Title:
Maximum Interval (minutes)
The default maximum interval in minutes. -
MaximumIntervalTypeCd: string
Title:
Maximum Interval Type Code
Maximum Length:30
The code that identifies the maximum interval type between work orders set on the link template. -
MinimumIntervalMinutes: integer
(int32)
Title:
Minimum Interval (minutes)
The default minimum interval in minutes. -
MinimumIntervalTypeCd: string
Title:
Minimum Interval Type Code
Maximum Length:30
The code that identifies the minimum interval type between work orders set on the link template. -
SchedulingConstraintCd: string
Title:
Scheduling Constraints Code
Maximum Length:30
The code that identifies the scheduling constraint set on the link template. -
WoLinkTemplateTranslation: array
Link Template Translations
Title:
Link Template Translations
The work order link template translations resource shows all the translatable values for the work order link templates resource.
Nested Schema : Link Template Translations
Type:
array
Title:
Link Template Translations
The work order link template translations resource shows all the translatable values for the work order link templates resource.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Maximum Length:256
The link type name that identifies the link for the second work order. -
SourceLang: string
Title:
Source Language
Maximum Length:4
The source language code from which the link template is translated.
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 : svcWoLinkTemplates-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates if link template for the link is active. -
AssignConstCdMeaning: string
Title:
Assignment Constraint
Read Only:true
The name of the assignment constraint selected for this link template. -
AssignmentConstraintCd: string
Title:
Assignment Constraints Code
Maximum Length:30
The code that identifies the assignment constraint set on the link template. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the link template. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the link template. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time of last update for the link template. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The source who last updated the link template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTemplateCatCd: string
Title:
Link Template Category Code
Maximum Length:30
The code that identifies template category selected for this link template. -
LinkTemplateCatCdMeaning: string
Title:
Link Template Category
Read Only:true
The name of the template category selected for this link template. -
LinkTemplateId: integer
(int64)
Title:
Link Template ID
Read Only:true
The unique identifier of the link template. -
LinkTemplateNumber: string
Title:
Link Template Number
Maximum Length:30
Value that uniquely identifies the alternate unique identifier for the link template. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000. -
LinkTypeLabelFirst: string
Title:
Link Label for First Work Order
Maximum Length:160
The link type label that identifies the link for the first work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeLabelSecond: string
Title:
Link Label for Second Work Order
Maximum Length:160
The link type label that identifies the link for the second work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Maximum Length:256
The link type name that identifies the link for the second work order. -
MaximumIntervalMinutes: integer
(int32)
Title:
Maximum Interval (minutes)
The default maximum interval in minutes. -
MaximumIntervalTypeCd: string
Title:
Maximum Interval Type Code
Maximum Length:30
The code that identifies the maximum interval type between work orders set on the link template. -
MaximumIntervalTypeCdMeaning: string
Title:
Maximum Interval Type
Read Only:true
The name of the maximum interval type selected for this link template. -
MinimumIntervalMinutes: integer
(int32)
Title:
Minimum Interval (minutes)
The default minimum interval in minutes. -
MinimumIntervalTypeCd: string
Title:
Minimum Interval Type Code
Maximum Length:30
The code that identifies the minimum interval type between work orders set on the link template. -
MinimumIntervalTypeCdMeaning: string
Title:
Minimum Interval Type
Read Only:true
The name of the minimum interval type selected for this link template. -
ScheduleConstCdMeaning: string
Title:
Scheduling Constraint
Read Only:true
The name of the scheduling constraint selected for this link template. -
SchedulingConstraintCd: string
Title:
Scheduling Constraints Code
Maximum Length:30
The code that identifies the scheduling constraint set on the link template. -
WoLinkTemplateTranslation: array
Link Template Translations
Title:
Link Template Translations
The work order link template translations resource shows all the translatable values for the work order link templates resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Link Template Translations
Type:
array
Title:
Link Template Translations
The work order link template translations resource shows all the translatable values for the work order link templates resource.
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.
Nested Schema : svcWoLinkTemplates-WoLinkTemplateTranslation-item-response
Type:
Show Source
object
-
Language: string
Title:
Language
Maximum Length:4
The language code in which the link template is translated. -
LanguageDisplayName: string
Title:
Language Name
Read Only:true
Maximum Length:255
The language to which the link template is translated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Maximum Length:256
The link type name that identifies the link for the second work order. -
SourceLang: string
Title:
Source Language
Maximum Length:4
The source language code from which the link template is translated. -
SourceLangDisplayName: string
Title:
Source Language
Read Only:true
Maximum Length:255
The source language from which the link template is translated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WoLinkTemplateTranslation
-
Parameters:
- LinkTemplateId:
$request.path.LinkTemplateId
The work order link template translations resource shows all the translatable values for the work order link templates resource. - LinkTemplateId: