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

機械翻訳について

製品品目の作成 - サポートなし

post

/crmRestApi/resources/11.13.18.05/catalogProductItems

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

添付リソースは、製品品目の添付を表示するために使用されます。添付には、製品アイテムに関する追加情報が含まれます。
CountryCodeForEligibilityCheck: string

製品適格が定義されている国コード。
CurrencyCode: string

USDやEURなどの製品に関連付けられた通貨コード。
FilterByTM: string

最大長: 1

TMによるフィルタ。
GeographyId: string

製品の地理の一意の識別子。
ItemTranslation: array Item Translation

タイトル: Item Translation

製品品目リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDを表示するために使用されます。
ListPrice: number

タイトル: List Price

セグメント割引後の製品手数料の単価です。この値は価格設定エンジンによって提供されます。
OverrideEligYN: string

最大長: 1

資格が上書きされるかどうかを指定します。
UsageCode: string

最大長: 255

製品の使用コード。
UsageModeCode: string

最大長: 255

製品の使用モード・コード。
YourPrice: number

タイトル: Your Price

カタログに表示されている製品の価格。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code associated with the product like USD or EUR.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideEligYN":{
            "maxLength":1,
            "type":"string",
            "description":"Indicate whether the eligibility is overrode.",
            "nullable":true
        },
        "UsageCode":{
            "maxLength":255,
            "type":"string",
            "description":"The usage code of the product.",
            "nullable":true
        },
        "GeographyId":{
            "type":"string",
            "description":"The unique identifier of the geography of the product.",
            "nullable":true
        },
        "UsageModeCode":{
            "maxLength":255,
            "type":"string",
            "description":"The usage mode code of the product.",
            "nullable":true
        },
        "ItemTranslation":{
            "title":"Item Translation",
            "type":"array",
            "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-post-request"
            }
        },
        "CountryCodeForEligibilityCheck":{
            "type":"string",
            "description":"The country code for which product eligibility is defined.",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine.",
            "nullable":true,
            "x-queryable":false
        },
        "YourPrice":{
            "title":"Your Price",
            "type":"number",
            "description":"The your price of the product shown in the catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-Attachments-item-post-request"
            }
        },
        "FilterByTM":{
            "maxLength":1,
            "type":"string",
            "description":"The Filter by TM.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、製品品目の添付を表示するために使用されます。添付には、製品アイテムに関する追加情報が含まれます。

ソースを表示

Array of: object catalogProductItems-Attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-Attachments-item-post-request"
    }
}

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

タイプ: array

タイトル: Item Translation

製品品目リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDを表示するために使用されます。

ソースを表示

Array of: object catalogProductItems-ItemTranslation-item-post-request

{
    "title":"Item Translation",
    "type":"array",
    "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-post-request"
    }
}

ネストされたスキーマ : catalogProductItems-Attachments-item-post-request

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ名。
ContentRepositoryFileShared: boolean

タイトル: Shared

コンテンツ・リポジトリ・ファイルが共有されているかどうかを示します。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示すコード。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

文書の一意の識別子。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付ファイルのパス。
DmVersionNumber: string

最大長: 255

ドキュメントのバージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・タイプ(ある場合)を示すコード。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付のコンテンツ。
FileName: string

タイトル: File Name

最大長: 2048

添付ファイルの名前。
FileUrl: string

タイトル: File Url

添付のファイルURL。
Title: string

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付ファイルのコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルの長さ。
UploadedFileName: string

タイトル: Uploaded File Name

添付ファイルの名前。
UploadedText: string

タイトル: Uploaded Text

添付ファイルのテキスト。
Uri: string

タイトル: Uri

最大長: 4000

添付のURI。
Url: string

タイトル: Url

最大長: 4000

添付のURL。

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The file URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the content repository file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The path of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

ネストされたスキーマ : catalogProductItems-ItemTranslation-item-post-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

AttachmentEntityName: string

読取り専用: true

添付エンティティの名前。
Attachments: array Attachments

タイトル: Attachments

添付リソースは、製品品目の添付を表示するために使用されます。添付には、製品アイテムに関する追加情報が含まれます。
CountryCodeForEligibilityCheck: string

製品適格が定義されている国コード。
CSSEnabled: string

タイトル: Enable for Customer Self Service

読取り専用: true

最大長: 1

CSSが有効かどうかを示します。
CurrencyCode: string

USDやEURなどの製品に関連付けられた通貨コード。
CustomerOrderEnabledFlag: string

タイトル: Customer Orders Enabled

読取り専用: true

最大長: 1

製品を顧客別にオーダーできるかどうかを示します。
Depth: integer (int64)

読取り専用: true

パス内の最初の製品グループと最後の製品グループのレベルの差異。
Description: string

タイトル: Item Description

読取り専用: true

最大長: 240

製品の摘要。
FilterByTM: string

最大長: 1

TMによるフィルタ。
FirstProdGrpId: integer (int64)

読取り専用: true

リストの最初の製品の一意の識別子。
GeographyId: string

製品の地理の一意の識別子。
InventoryItemId: integer (int64)

タイトル: Item Number

読取り専用: true

在庫品目の一意の識別子。
ItemNumber: string

読取り専用: true

最大長: 300

品目の在庫品目番号。
ItemTranslation: array Item Translation

タイトル: Item Translation

製品品目リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDを表示するために使用されます。
links: array Links

タイトル: Links

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

タイトル: List Price

セグメント割引後の製品手数料の単価です。この値は価格設定エンジンによって提供されます。
LongDescription: string

タイトル: Long Description

読取り専用: true

最大長: 4000

製品の詳細説明。
OrganizationId: integer (int64)

タイトル: Organization

読取り専用: true

組織の一意の識別子。
OverrideEligYN: string

最大長: 1

資格が上書きされるかどうかを指定します。
ParentProductGroupId: integer (int64)

読取り専用: true

パス内の最後から2番目のノードに対する親製品グループの一意の識別子。
PathId: integer (int64)

読取り専用: true

パスの一意の識別子。
PrimaryUOMCode: string

タイトル: Primary UOM

読取り専用: true

最大長: 3

製品単位を示すコード。
ProductGroupDenormId: integer (int64)

読取り専用: true

製品グループ非正規化の一意の識別子。
ProductGroupId: integer (int64)

読取り専用: true

製品グループの一意の識別子。
SalesProductType: string

タイトル: Sales Product Type

読取り専用: true

最大長: 30

販売製品のタイプ。
ServReqEnabledCode: string

タイトル: Service Request

読取り専用: true

最大長: 30

サーバー・リクエストが有効かどうかを示すコード。
UsageCode: string

最大長: 255

製品の使用コード。
UsageModeCode: string

最大長: 255

製品の使用モード・コード。
YourPrice: number

タイトル: Your Price

カタログに表示されている製品の価格。

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":255,
            "type":"string",
            "description":"The usage code of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesProductType":{
            "title":"Sales Product Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "type":"string",
            "description":"The unique identifier of the geography of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerOrderEnabledFlag":{
            "title":"Customer Orders Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product can be ordered by customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine.",
            "nullable":true,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-Attachments-item-response"
            }
        },
        "Depth":{
            "type":"integer",
            "description":"The difference between the level of the first and the last product group in the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PathId":{
            "type":"integer",
            "description":"The unique identifier of the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code associated with the product like USD or EUR.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideEligYN":{
            "maxLength":1,
            "type":"string",
            "description":"Indicate whether the eligibility is overrode.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupDenormId":{
            "type":"integer",
            "description":"The unique identifier of the product group denorm.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The inventory item number of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServReqEnabledCode":{
            "title":"Service Request",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether server request is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstProdGrpId":{
            "type":"integer",
            "description":"The unique identifier of the first product on the list.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCodeForEligibilityCheck":{
            "type":"string",
            "description":"The country code for which product eligibility is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "title":"Primary UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code indicating the product unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemTranslation":{
            "title":"Item Translation",
            "type":"array",
            "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-response"
            }
        },
        "CSSEnabled":{
            "title":"Enable for Customer Self Service",
            "maxLength":1,
            "type":"string",
            "description":"Indicated whether CSS is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"The long description of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent product group for the penultimate node in the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageModeCode":{
            "maxLength":255,
            "type":"string",
            "description":"The usage mode code of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "YourPrice":{
            "title":"Your Price",
            "type":"number",
            "description":"The your price of the product shown in the catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FilterByTM":{
            "maxLength":1,
            "type":"string",
            "description":"The Filter by TM.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、製品品目の添付を表示するために使用されます。添付には、製品アイテムに関する追加情報が含まれます。

ソースを表示

Array of: object catalogProductItems-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-Attachments-item-response"
    }
}

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

タイプ: array

タイトル: Item Translation

製品品目リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDを表示するために使用されます。

ソースを表示

Array of: object catalogProductItems-ItemTranslation-item-response

{
    "title":"Item Translation",
    "type":"array",
    "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-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"
    }
}

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

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ名。
ContentRepositoryFileShared: boolean

タイトル: Shared

コンテンツ・リポジトリ・ファイルが共有されているかどうかを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

添付を作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

添付を作成した個人のユーザー名。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

添付レコードが作成された日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示すコード。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

文書の一意の識別子。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付ファイルのパス。
DmVersionNumber: string

最大長: 255

ドキュメントのバージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・タイプ(ある場合)を示すコード。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付のコンテンツ。
FileName: string

タイトル: File Name

最大長: 2048

添付ファイルの名前。
FileUrl: string

タイトル: File Url

添付のファイルURL。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

添付が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

添付を最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

添付を最後に更新した個人のユーザー名。
links: array Links

タイトル: Links

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

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付ファイルのコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルの長さ。
UploadedFileName: string

タイトル: Uploaded File Name

添付ファイルの名前。
UploadedText: string

タイトル: Uploaded Text

添付ファイルのテキスト。
Uri: string

タイトル: Uri

最大長: 4000

添付のURI。
Url: string

タイトル: Url

最大長: 4000

添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付を作成した個人のユーザー名。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The user name of the person who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The file URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the content repository file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The path of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

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

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

タイプ: object

ソースを表示

Description: string

タイトル: Item Description

読取り専用: true

最大長: 240

品目の翻訳済摘要。
InventoryItemId: integer (int64)

タイトル: Item Number

読取り専用: true

在庫品目の一意の識別子。
ISOLanguage: string

読取り専用: true

最大長: 2

英語やデンマーク語など、製品アイテムに関連付けられたISO言語。
ISOTerritory: string

タイトル: Territory

読取り専用: true

最大長: 2

製品品目に関連付けられたISOテリトリ。
Language: string

読取り専用: true

最大長: 4

アイテムの翻訳言語。
LanguageCode: string

タイトル: Language Code

読取り専用: true

最大長: 4

639-1en (英語)や639-1da (デンマーク語)などの製品アイテムに関連付けられた言語コード。
links: array Links

タイトル: Links

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

タイトル: Long Description

読取り専用: true

最大長: 4000

品目の長い翻訳済摘要。
OrganizationId: integer (int64)

タイトル: Organization

読取り専用: true

品目が属する組織の一意の識別子。

{
    "type":"object",
    "properties":{
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The language code associated with the product item like 639-1en (English) or 639-1da (Danish).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"The long translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The translation language of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ISOTerritory":{
            "title":"Territory",
            "maxLength":2,
            "type":"string",
            "description":"The ISO territory associated with the product item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the item belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ISOLanguage":{
            "maxLength":2,
            "type":"string",
            "description":"The ISO language associated with the product item like English or Danish.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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"
    }
}

リンク

添付

操作: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments

パラメータ:

catalogProductItemsUniqID: $request.path.catalogProductItemsUniqID

添付リソースは、製品品目の添付を表示するために使用されます。添付には、製品アイテムに関する追加情報が含まれます。

ItemTranslation

操作: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation

パラメータ:

catalogProductItemsUniqID: $request.path.catalogProductItemsUniqID

製品品目リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDを表示するために使用されます。

「トップに戻る」