機械翻訳について

ジャンプ先

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

添付の作成

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/attachments

リクエスト

パス・パラメータ

• draftPurchaseOrdersUniqID(required): string
  これは、下書き購買オーダー・リソースの複合キーを構成し、下書き購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ドラフト購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト購買オーダー・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は有効日RESTリソースではサポートされていません。

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

• application/json

リクエスト本文 - application/json ()

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

タイプ: object

ソースを表示

• AsyncTrackerId: string
  タイトル: Asynchronous Upload Tracker Id

  アップロードされたファイルのトラッキングに使用される識別子。
• AttachedDocumentId: integer (int64)
  タイトル: Attached Document Id

  購買オーダーに添付された文書を一意に識別する値。 これは、ユーザーが購買オーダーに文書を添付するときにアプリケーションが作成する主キーです。
• CategoryName: string
  タイトル: Category

  最大長: 30

  添付文書のカテゴリです。
• ContentRepositoryFileShared: boolean
  タイトル: Shared

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、添付されたドキュメントが共有されます。 falseの場合、添付されたドキュメントは共有されません。 デフォルト値はfalseです。
• 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: string (byte)
  タイトル: File Contents

  添付文書の内容。
• FileName: string
  タイトル: File Name

  最大長: 2048

  添付ドキュメントのファイル名。
• FileUrl: string
  タイトル: File Url

  添付ドキュメントのURL (Uniform Resource Locator)。
• 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 (Uniform Resource Identifier)。
• Url: string
  タイトル: Url

  最大長: 4000

  添付されたドキュメントを識別するURI (Uniform Resource Identifier)。

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies 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":"File name of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order.",
            "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":"Contents of the attached document.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the content in the attached document expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large 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":"Folder path of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

トップに戻る

レスポンス

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文 ()

ルート・スキーマ : draftPurchaseOrders-attachments-item-response

タイプ: object

ソースを表示

• AsyncTrackerId: string
  タイトル: Asynchronous Upload Tracker Id

  アップロードされたファイルのトラッキングに使用される識別子。
• AttachedDocumentId: integer (int64)
  タイトル: Attached Document Id

  購買オーダーに添付された文書を一意に識別する値。 これは、ユーザーが購買オーダーに文書を添付するときにアプリケーションが作成する主キーです。
• CategoryName: string
  タイトル: Category

  最大長: 30

  添付文書のカテゴリです。
• ContentRepositoryFileShared: boolean
  タイトル: Shared

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、添付されたドキュメントが共有されます。 falseの場合、添付されたドキュメントは共有されません。 デフォルト値はfalseです。
• 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: string (byte)
  タイトル: File Contents

  添付文書の内容。
• FileName: string
  タイトル: File Name

  最大長: 2048

  添付ドキュメントのファイル名。
• FileUrl: string
  タイトル: File Url

  添付ドキュメントのURL (Uniform Resource Locator)。
• FileWebImage: string (byte)
  タイトル: 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 (Uniform Resource Identifier)。
• Url: string
  タイトル: Url

  最大長: 4000

  添付されたドキュメントを識別するURI (Uniform Resource Identifier)。
• UserName: string
  タイトル: User Name

  読取り専用: true

  最大長: 255

  添付文書の追加または変更時にユーザーが使用したログイン。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attached document.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attached document.",
            "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":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached 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":"Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order.",
            "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":"Content type of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large 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":"Login that the user used when creating the document that is attached to the purchase order.",
            "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":"Length of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached 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":"User who most recently updated the document that is attached to the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding or modifying the attached document.",
            "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":"User who created the attached document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies 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":"Title of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document that is attached to the purchase order.",
            "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":"Name of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached document.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the content in the attached document expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attached document.",
            "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":"Folder path of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attached document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that is attached to the purchase order.",
            "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":"An identifier used for tracking the uploaded 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."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

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

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

トップに戻る

例

この例では、添付をアップロードする方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/attachments"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 この例では、添付ファイルが購買オーダー・ヘッダーに正常にアップロードされます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
	"DatatypeCode": "FILE",
	"FileName": "REST Attachment.txt",
	"CategoryName": "TO_SUPPLIER",
	"UploadedFileContentType": "text/plain",
	"ContentRepositoryFileShared": "false",
	"Title": "REST Attachment.txt",
	"Description": "description",
	"FileContents": "UmFnaGF2YQ=="
}

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
	"AttachedDocumentId": 300100197971814,
	"LastUpdateDate": "2020-10-16T10:31:21.962+00:00",
	"LastUpdatedBy": "BUYER01",
	"DatatypeCode": "FILE",
	"FileName": "REST Attachment.txt",
	"DmFolderPath": null,
	"DmDocumentId": "UCMFA00023337",
	"DmVersionNumber": "23340",
	"Url": null,
	"CategoryName": "TO_SUPPLIER",
	"UserName": null,
	"Uri": null,
	"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a23340?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=8218827411774827109&XFND_EXPIRES;=1602844882473&XFND_SIGNATURE;=QZY-WQBfcENl4lGpoMYLC3KT0d9K~pPk4vHD1TnZR5ChOed2nML1-3FCcxa17YUfgRXuYvfFRB~x2-wSMcio2QTP8hMZtUEGa0E-~ybM7focVl4aAzq8hkHBADMC~yudXpxKbGEBl~FqxI3bTBTNqKa5klm0cqizVB9JHijMU8bpCQya45bl9Jk6OtsV8csltoMySwH4R7asj15WXqnX5YmnO7R-OjscJ8PLPAJpWULJELqGl5437om~umLgQRqdGnf63VZxZGjEQsoOS7gaf-sqBdNfZNwMPbOAAMrFRHynaZR22SD1MjuYHG9fMN6duVnAMTHanaHY9iFouQwFqw__&Id;=23340&download;",	"UploadedText": null,
	"UploadedFileContentType": "text/plain",
	"UploadedFileLength": 7,
	"UploadedFileName": "REST Attachment.txt",
	"ContentRepositoryFileShared": "false",
	"Title": "REST Attachment.txt",
	"Description": "description",
	"ErrorStatusCode": null,
	"ErrorStatusMessage": null,
	"CreatedBy": "BUYER01",
	"CreationDate": "2020-10-16T10:31:21+00:00",
	"ExpirationDate": null,
	"LastUpdatedByUserName": "Clare Jones",
	"CreatedByUserName": "Clare Jones",
	"AsyncTrackerId": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765",
		"name": "attachments",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765",
		"name": "attachments",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749",
		"name": "draftPurchaseOrders",
		"kind": "item"
	},
	{
		"rel": "enclosure",
		"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765/enclosure/FileContents",
		"name": "FileContents",
		"kind": "other"
	}
	]
}

「トップに戻る」