patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}
リクエスト
パス・パラメータ
- InternalSharedDocumentsUniqID(required): string
これは、内部共有ドキュメント・リソースのコンポジット・キーを構成し、内部共有ドキュメントのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは内部共有ドキュメントの特定のインスタンスに移動してハッシュ・キーを取得するために、内部共有ドキュメント・コレクション・リソースを問い合せる必要があります。
- contractsUniqID(required): string
これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
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"
}
},
"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"
}
}
}
}
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contracts-InternalSharedDocuments-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
リソース・インスタンスに関連付けられたリンク関係。
ソースを表示
{
"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."
}
}
}