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

機械翻訳について

サポート文書の作成

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments

リクエスト

パス・パラメータ

contractsUniqID(required): string

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

ヘッダー・パラメータ

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

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

内部共有ドキュメントの非同期トラッカID。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付された内部共有文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

内部共有文書が割り当てられるカテゴリのコード。
ContentRepositoryFileShared: boolean

タイトル: Shared

内部共有文書がコンテンツ・リポジトリで共有されるかどうかを示します。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

外部共有文書がファイルまたはURLであるかどうかを識別するコード。
Description: string

タイトル: Description

最大長: 255

内部共有文書の摘要。
DmDocumentId: string

最大長: 255

内部共有ドキュメントのDMドキュメントID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

内部共有ドキュメントのDmフォルダ・パス。
DmVersionNumber: string

最大長: 255

内部共有ドキュメントのDmバージョン番号。
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

内部共有ドキュメントのファイル名。ファイル名またはURLが必要です。
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。ファイル名またはURLが必要です。

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error status message for the internal shared document.",
            "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 internal shared document.",
            "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 identifies if the external shared document is a file or a URL.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the internal shared document. A  file name or URL is required.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the internal shared document.",
            "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 internal shared document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the internal shared document. A file name or URL is required.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The uploaded file name of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The Dm document id of the internal shared 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 URL location of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates if the internal shared document is shared in the content repository.",
            "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 attached internal shared document.",
            "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 file contents of the internal shared document.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The uploaded file content type of the internal shared document.",
            "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 internal shared document.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error status code for the internal shared document.",
            "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 Dm folder path of the internal shared document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The uploaded text of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code for the category to which the internal shared document is assigned.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The uploaded file length of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The Dm version number of the internal shared document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The async tracker ID of the internal shared document.",
            "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のデフォルト・バージョンを選択します。

ルート・スキーマ : contracts-SupportingDocuments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

内部共有ドキュメントの非同期トラッカID。
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

外部共有文書がファイルまたはURLであるかどうかを識別するコード。
Description: string

タイトル: Description

最大長: 255

内部共有文書の摘要。
DmDocumentId: string

最大長: 255

内部共有ドキュメントのDMドキュメントID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

内部共有ドキュメントのDmフォルダ・パス。
DmVersionNumber: string

最大長: 255

内部共有ドキュメントのDmバージョン番号。
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

内部共有ドキュメントのファイル名。ファイル名またはURLが必要です。
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。ファイル名またはURLが必要です。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

内部共有文書が割り当てられるカテゴリの名前。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the internal shared document 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 internal shared 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":"The file name of the internal shared document. A  file name or URL is required.",
            "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 internal shared document.",
            "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 internal shared document. A file name or URL is required.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The Dm document id of the internal shared 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 attached internal shared document.",
            "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 uploaded file content type of the internal shared document.",
            "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 name of the user who created the internal shared document.",
            "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 uploaded file length of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The Dm version number of the internal shared 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 login user name associated with the user who last updated the internal shared document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error status message for the internal shared 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":"The name of the category to which the internal shared document is assigned.",
            "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 internal shared document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies if the external shared document is a file or a URL.",
            "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 internal shared 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":"The name of the user who last updated the internal shared document.",
            "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 uploaded file name of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL location of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates if the internal shared document is shared in the content repository.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The file contents of the internal shared document.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the internal shared document.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error status code for the internal shared 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":"The Dm folder path of the internal shared document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The uploaded text of the internal shared document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code for the category to which the internal shared document is assigned.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the internal shared document 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":"The async tracker ID of the internal shared document.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行して、サポート・ドキュメントを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832/child/SupportingDocumentss

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"CategoryName": "OKC_DOCUMENTS_SUPPORTING_DOC",
"DatatypeCode": "FILE",
"FileContents": "UHJvYmFuZG8gZWwgZG9jdW1lbnRvCg==",
"Title" : "Sample File attachment2",
"FileName": "New_Test_Attachment.txt"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "AttachedDocumentId": 300100576697593,
    "LastUpdateDate": "2023-06-27T10:05:10.355+00:00",
    "LastUpdatedBy": "CONMGR",
    "DatatypeCode": "FILE",
    "FileName": "New_Test_Attachment.txt",
    "DmFolderPath": null,
    "DmDocumentId": "UCMFA00118419",
    "DmVersionNumber": "118419",
    "Url": null,
    "CategoryName": "OKC_DOCUMENTS_SUPPORTING_DOC",
    "UserName": "Supporting Document",
    "Uri": null,
    "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:118419?download&XFND_SCHEME_ID=1&XFND_CERT_FP=050B97D1B0F57AC305F88E205CE029181C4A07C8&XFND_RANDOM=634506208053873167&XFND_EXPIRES=1687860909895&XFND_SIGNATURE=ZYo3QQZhRbG~lQI1yU-yntlHImNhPZJXPmkvIS6Yh3IPiZVtjxyyLAN3Lts1qLqJ93aZCc2gkCy4FoiHZ8CqEQPQ~ChzOIjnU5CFtvLnN2FzP9Y8TyAcc04wMB8HZFulPZ89uOIyyEhSC6tRLXPbidwfnm0Krp0CswphDHdOV-AMYcLWT0RjJ8xRxl4YAe58SFA11ud4v-QlYCzfbBKPFU9c0IB8eYAKnKxdAjH7NU-O79xBf~8HVzHw1hvqcm24B8q2M-lUxdYhV7yp8CMx5FQHm4LjznlbusozKQI3bomG431n7uG3u1FE6uxNQVg4E0BbwuvDqZT-7WY7ofCw6w__&Id=118419",
    "UploadedText": null,
    "UploadedFileContentType": "text/plain",
    "UploadedFileLength": 22,
    "UploadedFileName": "New_Test_Attachment.txt",
    "ContentRepositoryFileShared": "false",
    "Title": "Sample File attachment2",
    "Description": "",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "CONMGR",
    "CreationDate": "2023-06-27T10:05:08+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Quinn MaxOliv",
    "CreatedByUserName": "Quinn MaxOliv",
    "AsyncTrackerId": null,
    "DownloadInfo": "{\"XFND_EXPIRES\":\"1687860909900\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"050B97D1B0F57AC305F88E205CE029181C4A07C8\",\"XFND_SIGNATURE\":\"a-w7QWUg1H460FomcySTTXHCz3MXgAOjDXf0d-A~a9AFuk~k~b434yAaJJ-itj4xyYEZKMq6UQsMzbH7bBw6fxM9R6jurHFMsOuP18K9WheHkHoRUWYHyAETyti4MUMRyumcGjpKP77tmudjR6D85ZfHuQ-2krRWEcNpGj~sGm0QHuvLNuZnqw1tA~smyH5t9RERIb7sVOpoC-VxbXoYaVc~T6i~vN4yn8nWqKMIFOTIjxVBoV1Qs5IQQETv~oa~PIJ6db5Mt9~0jXIuYVVxkc0Hx0rrxdHOa0tLio9eyfLkJwQV7WY6d5yXW2bs0DiwqGzB4ZvlfZhQ5PpM6x~LmQ__\",\"XFND_RANDOM\":\"-6195049476750466687\"}",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832/child/SupportingDocuments/00020000000EACED00057708000110F09C455CF90000000EACED00057708000110F09C455CF8",
            "name": "SupportingDocuments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832/child/SupportingDocuments/00020000000EACED00057708000110F09C455CF90000000EACED00057708000110F09C455CF8",
            "name": "SupportingDocuments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832",
            "name": "contracts",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832/child/SupportingDocuments/00020000000EACED00057708000110F09C455CF90000000EACED00057708000110F09C455CF8/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430832/child/SupportingDocuments/00020000000EACED00057708000110F09C455CF90000000EACED00057708000110F09C455CF8/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}

「トップに戻る」