機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

値リストからリンク・テンプレートを取得

get

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

リクエスト

パス・パラメータ

• svcWoLinkTemplatesLOVUniqID(required): string
  これは、作業オーダー・リンク・テンプレートLOVリソースに対して複合キー(LinkTemplateCatCdおよびLinkTemplateCatDirCd)を構成する属性のハッシュ・キーで、作業オーダー・リンク・テンプレートLOVのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、作業オーダー・リンク・テンプレートLOVの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して、作業オーダー・リンク・テンプレートLOVコレクション・リソースを問い合せる必要があります。
  
  次に例を示します: svcWoLinkTemplatesLOV?q=LinkTemplateCatCd=<value1>;LinkTemplateCatDirCd=<value2>

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : svcWoLinkTemplatesLOV-item-response

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  読取り専用: true

  最大長: 1

  リンクのリンク・テンプレートがアクティブかどうかを示します。
• AssignConstCdMeaning: string
  タイトル: Assignment Constraint Meaning

  読取り専用: true

  このリンク・テンプレートに対して選択された割当制約の名前。
• AssignmentConstraintCd: string
  タイトル: Assignment Constraints Code

  読取り専用: true

  最大長: 30

  リンク・テンプレートに設定された割当制約を識別するコード。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LinkTemplateCatCd: string
  タイトル: Link Template Category Code

  読取り専用: true

  最大長: 30

  このリンク・テンプレートに選択されたテンプレート・カテゴリを識別するコード。
• LinkTemplateCatCdMeaning: string
  タイトル: Link Template Category Meaning

  読取り専用: true

  このリンク・テンプレートに選択されたテンプレート・カテゴリの名前。
• LinkTemplateCatDirCd: string
  タイトル: Link Template Category Direction Code

  読取り専用: true

  最大長: 37

  このリンク・テンプレートに選択されたテンプレート・カテゴリ方向を識別するコード。
• LinkTemplateCatDirCdMeaning: string
  タイトル: Link Template Category Direction

  読取り専用: true

  このリンク・テンプレートに選択されたテンプレート・カテゴリ方向の名前。
• LinkTemplateId: integer (int64)
  タイトル: Link Template ID

  読取り専用: true

  リンク・テンプレートの一意の識別子。
• LinkTemplateNumber: string
  タイトル: Link Template Number

  読取り専用: true

  最大長: 30

  リンク・テンプレートの代替一意識別子を一意に識別する値。 この値は、システム生成にすることも、構成することもできます。 デフォルトの構成はCDRM-0000000000です。
• LinkTypeLabel: string
  タイトル: Link Type Label

  読取り専用: true

  最大長: 160

  リンクを識別するリンク・タイプ・ラベル。
• LinkTypeName: string
  タイトル: Link Type Name

  読取り専用: true

  最大長: 256

  リンクを識別するリンク・タイプ名。
• MaximumIntervalMinutes: 整数(int32)
  タイトル: Maximum Interval (minutes)

  読取り専用: true

  デフォルトの最大間隔(分)。
• MaximumIntervalTypeCd: string
  タイトル: Minimum Interval Type Code

  読取り専用: true

  最大長: 30

  リンク・テンプレートで設定された作業オーダー間の最大間隔タイプを識別するコード。
• MaximumIntervalTypeCdMeaning: string
  タイトル: Maximum Interval Type Meaning

  読取り専用: true

  このリンク・テンプレートに選択された最大間隔タイプの名前。
• MinimumIntervalMinutes: 整数(int32)
  タイトル: Maximum Interval (minutes)

  読取り専用: true

  デフォルトの最小間隔(分)。
• MinimumIntervalTypeCd: string
  タイトル: Maximum Interval Type Code

  読取り専用: true

  最大長: 30

  リンク・テンプレートで設定された作業オーダー間の最小間隔タイプを識別するコード。
• MinimumIntervalTypeCdMeaning: string
  タイトル: Minimum Interval Type Meaning

  読取り専用: true

  このリンク・テンプレートに選択された最小間隔タイプの名前。
• ScheduleConstCdMeaning: string
  タイトル: Scheduling Constraint Meaning

  読取り専用: true

  このリンク・テンプレートに対して選択されたスケジューリング制約の名前。
• SchedulingConstraintCd: string
  タイトル: Scheduling Constraints Code

  読取り専用: true

  最大長: 30

  リンク・テンプレートに設定されたスケジューリング制約を識別するコード。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "AssignConstCdMeaning":{
            "title":"Assignment Constraint Meaning",
            "type":"string",
            "description":"The name of the assignment constraint selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if link template for the link is active.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MaximumIntervalTypeCdMeaning":{
            "title":"Maximum Interval Type Meaning",
            "type":"string",
            "description":"The name of the maximum interval type selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "ScheduleConstCdMeaning":{
            "title":"Scheduling Constraint Meaning",
            "type":"string",
            "description":"The name of the scheduling constraint selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumIntervalTypeCdMeaning":{
            "title":"Minimum Interval Type Meaning",
            "type":"string",
            "description":"The name of the minimum interval type selected for this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LinkTemplateCatCdMeaning":{
            "title":"Link Template Category Meaning",
            "type":"string",
            "description":"The name of the template category 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
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」