Create a link template

post

/crmRestApi/resources/11.13.18.05/svcWoLinkTemplates

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Default Value: false
    Indicates if link template for the link is active.
  • Title: Assignment Constraints Code
    Maximum Length: 30
    The code that identifies the assignment constraint set on the link template.
  • Title: Link Template Category Code
    Maximum Length: 30
    The code that identifies template category selected for this link template.
  • 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.
  • 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.
  • 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.
  • Title: Link Name for First Work Order
    Maximum Length: 256
    The link type name that identifies the link for the first work order.
  • Title: Link Name for Second Work Order
    Maximum Length: 256
    The link type name that identifies the link for the second work order.
  • Title: Maximum Interval (minutes)
    The default maximum interval in minutes.
  • Title: Maximum Interval Type Code
    Maximum Length: 30
    The code that identifies the maximum interval type between work orders set on the link template.
  • Title: Minimum Interval (minutes)
    The default minimum interval in minutes.
  • Title: Minimum Interval Type Code
    Maximum Length: 30
    The code that identifies the minimum interval type between work orders set on the link template.
  • Title: Scheduling Constraints Code
    Maximum Length: 30
    The code that identifies the scheduling constraint set on the link template.
  • 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 : svcWoLinkTemplates-WoLinkTemplateTranslation-item-post-request
Type: object
Show Source
  • Title: Language
    Maximum Length: 4
    The language code in which the link template is translated.
  • Title: Link Name for First Work Order
    Maximum Length: 256
    The link type name that identifies the link for the first work order.
  • Title: Link Name for Second Work Order
    Maximum Length: 256
    The link type name that identifies the link for the second work order.
  • Title: Source Language
    Maximum Length: 4
    The source language code from which the link template is translated.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : svcWoLinkTemplates-item-response
Type: object
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 : svcWoLinkTemplates-WoLinkTemplateTranslation-item-response
Type: object
Show Source
  • Title: Language
    Maximum Length: 4
    The language code in which the link template is translated.
  • Title: Language Name
    Read Only: true
    Maximum Length: 255
    The language to which the link template is translated.
  • Links
  • Title: Link Name for First Work Order
    Maximum Length: 256
    The link type name that identifies the link for the first work order.
  • Title: Link Name for Second Work Order
    Maximum Length: 256
    The link type name that identifies the link for the second work order.
  • Title: Source Language
    Maximum Length: 4
    The source language code from which the link template is translated.
  • Title: Source Language
    Read Only: true
    Maximum Length: 255
    The source language from which the link template is translated.
Back to Top