Oracle Fusion Cloud ProcurementのREST API

添付の更新

patch

/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/attachments/{attachmentsUniqID}

リクエスト

パス・パラメータ

attachmentsUniqID(required): string

これは、添付リソースのコンポジット・キーを構成し、添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ハッシュ・キーを取得するために添付の特定のインスタンスに移動するために、添付の収集リソースを問い合せる必要があります。
workConfirmationsUniqID(required): string

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

タイプ: object

ソースを表示

CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付を共有するかどうかを示します。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示す値。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元であるドキュメントID。
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

ファイルのURI。
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

webページ・タイプの添付の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":"A value 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 file name of the attachment.",
            "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 a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment 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 contents 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.",
            "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 error code, 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-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":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size 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 document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : workConfirmations-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

添付の作成元であるドキュメントID。
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

ファイルのURI。
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。
Url: string

タイトル: Url

最大長: 4000

webページ・タイプの添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付を作成したユーザーのログイン資格証明。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the 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 file name of the attachment.",
            "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 a Topology Manager type 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 a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "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 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 content type of the attachment.",
            "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":"The user name who created the record.",
            "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 size 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 document version number from which the attachment is created.",
            "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 record.",
            "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 login credentials of the user 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value 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 who last updated the record.",
            "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 to assign to a new 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 URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment 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 contents 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 error code, 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 folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "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 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 when the record 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."
                }
            }
        }
    }
}

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

タイプ: 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 -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationId/child/attachments/AttachedDocumentId"

たとえば:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d' "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/300100552062232"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。

"{
	"Description": "Updated attachment description"
}"

レスポンス本文の例

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

(
    "AttachedDocumentId": 300100552062232,
    "LastUpdateDate": "2022-02-02T13:33:28.236+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "DatatypeCode": "TEXT",
    "FileName": "File Name",
    "DmFolderPath": null,
    "DmDocumentId": "UCMFA00123009",
    "DmVersionNumber": "123209",
    "Url": null,
    "CategoryName": "FROM_SUPPLIER",
    "UserName": null,
    "Uri": null,
    "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:123209?download&XFND_SCHEME_ID=1&XFND_CERT_FP=050B97D1B0F57AC305F88E205CE029181C4A07C8&XFND_RANDOM=4437122959824225596&XFND_EXPIRES=1643809408461&XFND_SIGNATURE=Uj0IABIppQeEboBCbrKHBZ1MWmeo9YlvTFfW0KDsxJWUhKJduWo0sngXe3nTM4Hg8ScdHl78SC9RBBMNBtgydyf1g8~1gy7~2sT8s0nlqS8l8bKHc6oRGr3STBtl-KpXx4l7xnmKpDedyaZIEacWyX8chmGPVHo8lY5KO-gAK~8X0iiZi59EMzhlTZBtR~wwUiFEny72nKtnF2MQhqIlOy0CalSTbCDhfyJIo~vkiPPLCIb0C8OYolXl~5M-jjAEZ9JIbxI7Hob~XrXPsm3xFYU6XfUJ0ZtoC-pohocfgg-3qxxHcxtDFZsy90CPgI9DP-QV4OAbGFOCy5lWBLjcwg__&Id=123209",
    "UploadedText": null,
    "UploadedFileContentType": "text/plain",
    "UploadedFileLength": 7,
    "UploadedFileName": "REST Attachment Text-9722cf56-004a-4304-980b-c3ea89949b1d.txt",
    "ContentRepositoryFileShared": "false",
    "Title": "REST Attachment Text",
    "Description": "Updated attachment description",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2022-02-02T13:33:26+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Clare Jones",
    "CreatedByUserName": "Clare Jones",
    "AsyncTrackerId": null,
    "DownloadInfo": "{\"XFND_EXPIRES\":\"1643809408464\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"050B97D1B0F57AC305F88E205CE029181C4A07C8\",\"XFND_SIGNATURE\":\"cY3tuYzPIBE6Nby68NSUfJdrobXc3LGzrYEyvfZEZDDhjG5UjIy~-V-aU4KhRjgV5jL246Viaau8i8KcYx9MXEPeBiFLhHa5WCWjzuZaAHxy65AJYtCZFCzg97bbXr6qpoSHXDkcVrp4rdyeKqMC5ZufS78HGbKRvVE67IR-6tHX5RJIBrshf7Tm9DOhTbX1EC-K10Ym32oIVtX3hUGHtXKyegpl6VWWd5DkH6lj5b1cHQDhYrzU2p-6vOVoIO5pw3GjMoQPo-qgNmkBtfkpyJn00GjXDdpOo7vwryi3i2MifDlg5IXo34Qzw4GVQP3lFXaUEoUJy9~WSgXA6FcVfA__\",\"XFND_RANDOM\":\"8436617921277681430\"}",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517",
            "name": "attachments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517",
            "name": "attachments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317",
            "name": "workConfirmations",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}

「トップに戻る」