Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべてのリンク・テンプレートの取得

get

/crmRestApi/resources/11.13.18.05/svcWoLinkTemplates

リクエスト

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します
- PrimaryKey指定したリンク・テンプレートの一意の識別子に基づいてリンク・テンプレートを検索します。
  ファインダ変数
  - LinkTemplateId; integer;リンク・テンプレートのパブリック一意識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActiveFlag; boolean;リンクのリンク・テンプレートがアクティブかどうかを示します。
- AssignmentConstraintCd; string; リンク・テンプレートで設定された割当て制約を識別するコード。
- CreatedBy; string; リンク・テンプレートを作成したユーザー。
- CreationDate; string; リンク・テンプレートを作成する日時。
- LastUpdateDate; string; リンク・テンプレートの最終更新日時を示します。
- LastUpdatedBy; string; リンク・テンプレートを最後に更新したソース。
- LinkTemplateCatCd; string; このリンク・テンプレートに選択されたテンプレート・カテゴリを識別するコード。
- LinkTemplateId; integer; リンク・テンプレートの一意の識別子。
- LinkTemplateNumber; string; リンク・テンプレートの代替一意識別子を一意に識別する値。この値は、システム生成にすることも、構成することもできます。デフォルトの構成はCDRM-0000000000です。
- LinkTypeLabelFirst; string;最初の作業オーダーのリンクを識別するリンク・タイプ・ラベル。これは、Oracle Field Serviceのリンク・テンプレートに指定されているリンク・ラベルと完全に一致する必要があります。
- LinkTypeLabelSecond; string; 2番目の作業オーダーのリンクを識別するリンク・タイプ・ラベル。これは、Oracle Field Serviceのリンク・テンプレートに指定されているリンク・ラベルと完全に一致する必要があります。
- LinkTypeNameFirst; string; 最初の作業オーダーのリンクを識別するリンク・タイプ名。
- LinkTypeNameSecond; string; 2番目の作業オーダーのリンクを識別するリンク・タイプ名。
- MaximumIntervalMinutes; integer; デフォルトの最大間隔(分)。
- MaximumIntervalTypeCd; string; リンク・テンプレートで設定された作業オーダー間の最大間隔タイプを識別するコード。
- MinimumIntervalMinutes; integer; デフォルトの最小間隔(分)。
- MinimumIntervalTypeCd; string; リンク・テンプレートで設定された作業オーダー間の最小間隔タイプを識別するコード。
- SchedulingConstraintCd; string; リンク・テンプレートで設定されたスケジューリング制約を識別するコード。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : svcWoLinkTemplates

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/svcWoLinkTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object svcWoLinkTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/svcWoLinkTemplates-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : svcWoLinkTemplates-item-response

タイプ: object

ソースを表示

ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: false

リンクのリンク・テンプレートがアクティブかどうかを示します。
AssignmentConstraintCd: string

タイトル: Assignment Constraints Code

最大長: 30

リンク・テンプレートに設定された割当制約を識別するコード。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

リンク・テンプレートを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

リンク・テンプレートの作成日時。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

リンク・テンプレートの最終更新日時を示します。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

リンク・テンプレートを最後に更新したソース。
links: array Links

タイトル: Links

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

タイトル: Link Template Category Code

最大長: 30

このリンク・テンプレートに選択されたテンプレート・カテゴリを識別するコード。
LinkTemplateId: integer (int64)

タイトル: Link Template ID

読取り専用: true

リンク・テンプレートの一意の識別子。
LinkTemplateNumber: string

タイトル: Link Template Number

最大長: 30

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

タイトル: Link Label for First Activity

最大長: 160

最初の作業オーダーのリンクを識別するリンク・タイプ・ラベルです。これは、Oracle Field Serviceのリンク・テンプレートに指定されているリンク・ラベルと完全に一致する必要があります。
LinkTypeLabelSecond: string

タイトル: Link Label for Second Activity

最大長: 160

2番目の作業オーダーのリンクを識別するリンク・タイプ・ラベルです。これは、Oracle Field Serviceのリンク・テンプレートに指定されているリンク・ラベルと完全に一致する必要があります。
LinkTypeNameFirst: string

タイトル: Link Name for First Activity

最大長: 256

最初の作業オーダーのリンクを識別するリンク・タイプ名です。
LinkTypeNameSecond: string

タイトル: Link Name for Second Activity

最大長: 256

2番目の作業オーダーのリンクを識別するリンク・タイプ名。
MaximumIntervalMinutes: 整数(int32)

タイトル: Maximum Interval (minutes)

デフォルトの最大間隔(分)。
MaximumIntervalTypeCd: string

タイトル: Maximum Interval Type Code

最大長: 30

リンク・テンプレートで設定された作業オーダー間の最大間隔タイプを識別するコード。
MinimumIntervalMinutes: 整数(int32)

タイトル: Minimum Interval (minutes)

デフォルトの最小間隔(分)。
MinimumIntervalTypeCd: string

タイトル: Minimum Interval Type Code

最大長: 30

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

タイトル: Scheduling Constraints Code

最大長: 30

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

タイトル: Link Template Translations

作業オーダー・リンク・テンプレート翻訳リソースには、作業オーダー・リンク・テンプレート・リソースの翻訳可能なすべての値が表示されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The source who last updated the link template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentConstraintCd":{
            "title":"Assignment Constraints Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the assignment constraint set on the link template.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the link template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateId":{
            "title":"Link Template ID",
            "type":"integer",
            "description":"The unique identifier of the link template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeNameFirst":{
            "title":"Link Name for First Activity",
            "maxLength":256,
            "type":"string",
            "description":"The link type name that identifies the link for the first work order.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WoLinkTemplateTranslation":{
            "title":"Link Template Translations",
            "type":"array",
            "description":"The work order link template translations resource shows all the translatable values for the work order link templates resource.",
            "items":{
                "$ref":"#/components/schemas/svcWoLinkTemplates-WoLinkTemplateTranslation-item-response"
            }
        },
        "MinimumIntervalTypeCd":{
            "title":"Minimum 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LinkTypeLabelSecond":{
            "title":"Link Label for Second Activity",
            "maxLength":160,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumIntervalMinutes":{
            "title":"Minimum Interval (minutes)",
            "type":"integer",
            "description":"The default minimum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if link template for the link is active.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LinkTypeLabelFirst":{
            "title":"Link Label for First Activity",
            "maxLength":160,
            "type":"string",
            "description":"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.",
            "nullable":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":false,
            "x-queryable":true
        },
        "MaximumIntervalMinutes":{
            "title":"Maximum Interval (minutes)",
            "type":"integer",
            "description":"The default maximum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkTypeNameSecond":{
            "title":"Link Name for Second Activity",
            "maxLength":256,
            "type":"string",
            "description":"The link type name that identifies the link for the second work order.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SchedulingConstraintCd":{
            "title":"Scheduling Constraints Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the scheduling constraint set on the link template.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaximumIntervalTypeCd":{
            "title":"Maximum 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update for the link template.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : リンク・テンプレート翻訳

タイプ: array

タイトル: Link Template Translations

作業オーダー・リンク・テンプレート翻訳リソースには、作業オーダー・リンク・テンプレート・リソースの翻訳可能なすべての値が表示されます。

ソースを表示

Array of: object svcWoLinkTemplates-WoLinkTemplateTranslation-item-response

{
    "title":"Link Template Translations",
    "type":"array",
    "description":"The work order link template translations resource shows all the translatable values for the work order link templates resource.",
    "items":{
        "$ref":"#/components/schemas/svcWoLinkTemplates-WoLinkTemplateTranslation-item-response"
    }
}

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

タイプ: 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."
        }
    }
}

ネストされたスキーマ : svcWoLinkTemplates-WoLinkTemplateTranslation-item-response

タイプ: object

ソースを表示

Language: string

最大長: 4

リンク・テンプレートが翻訳される言語コード。
LanguageDisplayName: string

タイトル: Language Name

読取り専用: true

最大長: 255

リンク・テンプレートの翻訳先言語。
links: array Links

タイトル: Links

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

最大長: 256

最初の作業オーダーのリンクを識別するリンク・タイプ名です。
LinkTypeNameSecond: string

最大長: 256

2番目の作業オーダーのリンクを識別するリンク・タイプ名。
SourceLang: string

最大長: 4

リンク・テンプレートの翻訳元となるソース言語コード。
SourceLangDisplayName: string

タイトル: Language Name

読取り専用: true

最大長: 255

リンク・テンプレートの翻訳元となるソース言語。

{
    "type":"object",
    "properties":{
        "LinkTypeNameFirst":{
            "maxLength":256,
            "type":"string",
            "description":"The link type name that identifies the link for the first work order.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The language code in which the link template is translated.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"The source language code from which the link template is translated.",
            "nullable":false,
            "x-queryable":true
        },
        "LanguageDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The language to which the link template is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkTypeNameSecond":{
            "maxLength":256,
            "type":"string",
            "description":"The link type name that identifies the link for the second work order.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLangDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The source language from which the link template is translated.",
            "nullable":false,
            "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"
    }
}

「トップに戻る」