Jump to

• Request
• Response

Get a link template from list of values

get

/crmRestApi/resources/11.13.18.05/svcWoLinkTemplatesLOV/{svcWoLinkTemplatesLOVUniqID}

Request

Path Parameters

• svcWoLinkTemplatesLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LinkTemplateCatCd and LinkTemplateCatDirCd ---for the Work Order Link Templates LOV resource and used to uniquely identify an instance of Work Order Link Templates LOV. The client should not generate the hash key value. Instead, the client should query on the Work Order Link Templates LOV collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Order Link Templates LOV.
  
  For example: svcWoLinkTemplatesLOV?q=LinkTemplateCatCd=<value1>;LinkTemplateCatDirCd=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : svcWoLinkTemplatesLOV-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  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

  Read Only: true

  Maximum Length: 30

  The code that identifies the assignment constraint set on the link template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkTemplateCatCd: string
  Title: Link Template Category Code

  Read Only: true

  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.
• LinkTemplateCatDirCd: string
  Title: Link Template Category Direction Code

  Read Only: true

  Maximum Length: 37

  The code that identifies template category direction selected for this link template.
• LinkTemplateCatDirCdMeaning: string
  Title: Link Template Category Direction

  Read Only: true

  The name of the template category direction 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

  Read Only: true

  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.
• LinkTypeLabel: string
  Title: Link Type Label

  Read Only: true

  Maximum Length: 160

  The link type label that identifies the link.
• LinkTypeName: string
  Title: Link Type Name

  Read Only: true

  Maximum Length: 256

  The link type name that identifies the link.
• MaximumIntervalMinutes: integer (int32)
  Title: Maximum Interval (minutes)

  Read Only: true

  The default maximum interval in minutes.
• MaximumIntervalTypeCd: string
  Title: Minimum Interval Type Code

  Read Only: true

  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: Maximum Interval (minutes)

  Read Only: true

  The default minimum interval in minutes.
• MinimumIntervalTypeCd: string
  Title: Maximum Interval Type Code

  Read Only: true

  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

  Read Only: true

  Maximum Length: 30

  The code that identifies the scheduling constraint set on the link template.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if link template for the link is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignConstCdMeaning":{
            "title":"Assignment Constraint",
            "type":"string",
            "description":"The name of the assignment constraint selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentConstraintCd":{
            "title":"Assignment Constraints Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the assignment constraint set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatCd":{
            "title":"Link Template Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies template category selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatCdMeaning":{
            "title":"Link Template Category",
            "type":"string",
            "description":"The name of the template category selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LinkTemplateCatDirCd":{
            "title":"Link Template Category Direction Code",
            "maxLength":37,
            "type":"string",
            "description":"The code that identifies template category direction selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatDirCdMeaning":{
            "title":"Link Template Category Direction",
            "type":"string",
            "description":"The name of the template category direction selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LinkTemplateId":{
            "title":"Link Template ID",
            "type":"integer",
            "description":"The unique identifier of the link template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkTemplateNumber":{
            "title":"Link Template Number",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeLabel":{
            "title":"Link Type Label",
            "maxLength":160,
            "type":"string",
            "description":"The link type label that identifies the link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeName":{
            "title":"Link Type Name",
            "maxLength":256,
            "type":"string",
            "description":"The link type name that identifies the link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumIntervalMinutes":{
            "title":"Maximum Interval (minutes)",
            "type":"integer",
            "description":"The default maximum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MaximumIntervalTypeCd":{
            "title":"Minimum Interval Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the maximum interval type between work orders set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumIntervalTypeCdMeaning":{
            "title":"Maximum Interval Type",
            "type":"string",
            "description":"The name of the maximum interval type selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MinimumIntervalMinutes":{
            "title":"Maximum Interval (minutes)",
            "type":"integer",
            "description":"The default minimum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumIntervalTypeCd":{
            "title":"Maximum Interval Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the minimum interval type between work orders set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumIntervalTypeCdMeaning":{
            "title":"Minimum Interval Type",
            "type":"string",
            "description":"The name of the minimum interval type selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleConstCdMeaning":{
            "title":"Scheduling Constraint",
            "type":"string",
            "description":"The name of the scheduling constraint selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SchedulingConstraintCd":{
            "title":"Scheduling Constraints Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the scheduling constraint set on the link template.",
            "nullable":true,
            "readOnly":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