機械翻訳について

ジャンプ先

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

作業確認を1つ取得

get

/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}

リクエスト

パス・パラメータ

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

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。

ヘッダー・パラメータ

• Effective-Of:
  このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文 ()

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

タイプ: object

ソースを表示

• attachments: array Attachments
  タイトル: Attachments

  添付リソースは、作業確認の添付を管理します。
• BalanceToFinish: number
  読取り専用: true

  購買オーダーの作業を完了するための待ち状態の金額です。
• Buyer: string
  タイトル: Name

  読取り専用: true

  最大長: 240

  購買オーダーの管理を担当する個人。
• BuyerId: integer (int64)
  読取り専用: true

  購買オーダーのバイヤーを一意に識別する値。
• Comments: string
  最大長: 240

  作業確認に入力されたコメント。
• ContractAmountToDate: number
  読取り専用: true

  購買オーダーのオーダー金額。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  作業確認を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  サプライヤまたはアプリケーションが作業確認を作成した日時。
• Currency: string
  タイトル: Currency Name

  読取り専用: true

  最大長: 80

  購買オーダーの通貨。
• CurrencyCode: string
  読取り専用: true

  最大長: 15

  購買オーダーの通貨を識別する略称です。
• CurrentPaymentDue: number
  読取り専用: true

  パフォーマンスの期間に支払う必要がある金額。
• documentActions: array Document Actions
  タイトル: Document Actions

  文書処理リソースは、作業確認に対して実行された処理のリストを取得します。
• ImportSource: string
  最大長: 25

  作業確認のインポート元のソース・アプリケーションを示す値です。
• LastUpdateDate: string (date-time)
  読取り専用: true

  サプライヤまたはアプリケーションが作業確認を最後に更新した日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  作業確認を最後に更新したユーザー。
• lines: array Lines
  タイトル: Lines

  明細リソースは、パフォーマンス期間中に完了した作業の合計進捗率、数量または金額などの作業確認詳細を管理します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrderNumber: string
  タイトル: Order

  最大長: 30

  販売先法的エンティティの購買オーダーを一意に識別する番号です。
• PeriodEndDate: string (date)
  作業確認がアクティブでなくなったパフォーマンス期間。
• PeriodStartDate: string (date)
  作業確認がアクティブになるパフォーマンス期間。
• PODescription: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  購買オーダーの摘要。
• POHeaderId: integer (int64)
  購買オーダーを一意に識別する値。
• PreviouslyApprovedAmount: number
  読取り専用: true

  現在のパフォーマンス期間より前の購買オーダーの承認済作業確認金額合計。
• ProjectedRetainageThisPeriod: number
  読取り専用: true

  購買オーダーでパフォーマンス期間中に源泉徴収可能な留保金額の見積。
• SoldToLegalEntity: string
  タイトル: Legal Entity Name

  最大長: 240

  購買オーダーの購買を財務的に担当する法的エンティティです。
• SoldToLegalEntityId: integer (int64)
  購買オーダーの購買を財務的に担当する法的エンティティを一意に識別する値。
• Status: string
  タイトル: Meaning

  読取り専用: true

  最大長: 80

  作業確認のステータス。
• StatusCode: string
  読取り専用: true

  最大長: 25

  作業確認ステータスを識別する略称です。
• Supplier: string
  読取り専用: true

  最大長: 360

  購買オーダーのサプライヤの名前。
• SupplierId: integer (int64)
  読取り専用: true

  購買オーダーのサプライヤを一意に識別する値。
• SupplierSite: string
  タイトル: Site

  読取り専用: true

  最大長: 240

  サプライヤが購買オーダーの履行に使用する事業所。
• SupplierSiteId: integer (int64)
  読取り専用: true

  購買オーダーのサプライヤ・サイトを一意に識別する値。
• TotalCompletedThisPeriod: number
  読取り専用: true

  パフォーマンスの期間の購買オーダーにおける完了作業の合計金額。
• TotalCompletedToDate: number
  読取り専用: true

  購買オーダーにおける完了作業の合計金額。
• WorkConfirmationId: integer (int64)
  読取り専用: true

  作業確認を一意に識別する値。
• WorkConfirmationNumber: string
  読取り専用: true

  最大長: 30

  販売先法的エンティティの作業確認を一意に識別する番号です。
• WorkConfirmationRequestDate: string (date-time)
  作業確認がリクエストされた日付。
• WorkConfirmationSequenceNumber: integer (int64)
  読取り専用: true

  購買オーダーの作業確認の順序を一意に識別する番号です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the supplier or application created the work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachments for a work confirmation.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-attachments-item-response"
            }
        },
        "WorkConfirmationSequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of work confirmation on a purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Buyer":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Person who is responsible for managing the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order in a sold-to legal entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Legal entity that is financially responsible for purchases on the purchase order.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceToFinish":{
            "type":"number",
            "description":"Amount pending to complete the work on a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the work confirmation status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodEndDate":{
            "type":"string",
            "description":"Date when the period of performance for which work confirmation is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TotalCompletedThisPeriod":{
            "type":"number",
            "description":"Total amount of work completed on a purchase order for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation in a sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer on the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCompletedToDate":{
            "type":"number",
            "description":"Total amount of work completed on a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectedRetainageThisPeriod":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the purchase order for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "documentActions":{
            "title":"Document Actions",
            "type":"array",
            "description":"The Document Actions resource retrieves the list of actions performed on a work confirmation.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-documentActions-item-response"
            }
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-lines-item-response"
            }
        },
        "PODescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ImportSource":{
            "maxLength":25,
            "type":"string",
            "description":"Value that indicates the source application from which the work confirmation was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Comments entered for the work confirmation.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodStartDate":{
            "type":"string",
            "description":"Date when the period of performance for which work confirmation becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "WorkConfirmationRequestDate":{
            "type":"string",
            "description":"Date when the work confirmation is requested.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ContractAmountToDate":{
            "type":"number",
            "description":"Ordered amount on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPaymentDue":{
            "type":"number",
            "description":"Amount that needs be paid for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Location that the supplier uses to fulfill the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreviouslyApprovedAmount":{
            "type":"number",
            "description":"Total approved work confirmation amount of a purchase order prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier or application most recently updated the work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 添付

タイプ: array

タイトル: Attachments

添付リソースは、作業確認の添付を管理します。

ソースを表示

• Array of: object workConfirmations-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachments for a work confirmation.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-attachments-item-response"
    }
}

ネストされたスキーマ : 文書処理

タイプ: array

タイトル: Document Actions

文書処理リソースは、作業確認に対して実行された処理のリストを取得します。

ソースを表示

• Array of: object workConfirmations-documentActions-item-response

{
    "title":"Document Actions",
    "type":"array",
    "description":"The Document Actions resource retrieves the list of actions performed on a work confirmation.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-documentActions-item-response"
    }
}

ネストされたスキーマ : 明細

タイプ: array

タイトル: Lines

明細リソースは、パフォーマンス期間中に完了した作業の合計進捗率、数量または金額などの作業確認詳細を管理します。

ソースを表示

• Array of: object workConfirmations-lines-item-response

{
    "title":"Lines",
    "type":"array",
    "description":"The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-lines-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 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."
        }
    }
}

ネストされたスキーマ : workConfirmations-documentActions-item-response

タイプ: object

ソースを表示

• Action: string
  タイトル: Meaning

  読取り専用: true

  最大長: 80

  作業確認で実行された処理の名前。
• ActionCode: string
  最大長: 25

  作業確認で実行される処理の名前を識別する略称です。 有効な値は、送信、承認、否認および取下げです。
• ActionDate: string (date-time)
  ユーザーがアクションを実行した日時。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  作業確認時に処理を実行したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  ユーザーが作業確認に対して処理を実行した日時。
• LastUpdateDate: string (date-time)
  読取り専用: true

  ユーザーが作業確認の処理を最近実行した日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  作業確認の処理を最後に実行したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Note: string
  最大長: 255

  ユーザーが処理の実行中に入力したことに注意してください。
• ObjectId: integer (int64)
  作業確認を一意に識別する値。
• PerformedByUserName: string
  最大長: 255

  処理を実行した個人。
• PerformerId: integer
  処理を実行した個人を一意に識別する値。
• SequenceNumber: integer
  作業確認で実行される承認処理の順序を一意に識別する番号です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently performed the action on work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user performed the action on work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Action":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the action performed on the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the action on work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformedByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"Person who has performed the action.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PerformerId"
                ]
            }
        },
        "ObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PerformerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who has performed the action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the name of the action performed on the work confirmation. Valid values are submit, approve, reject, and withdraw.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date and time when the user performed an action.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "Note":{
            "maxLength":255,
            "type":"string",
            "description":"Note that the user entered while performing an action.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of an approval action performed on the work confirmation.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user recently performed the action on work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : workConfirmations-lines-item-response

タイプ: object

ソースを表示

• Amount: number
  期間または実績の分割払いスケジュールで完了した作業の金額。
• BalanceToFinish: number
  読取り専用: true

  分割払いスケジュールでの作業を完了するための待ち状態の金額。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  作業確認明細を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  サプライヤまたはアプリケーションが作業確認明細を作成した日時。
• LastUpdateDate: string (date-time)
  読取り専用: true

  サプライヤまたはアプリケーションが作業確認明細を最後に更新した日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  作業確認明細を最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MaximumRetainageAmount: number
  タイトル: Maximum Retainage Amount

  読取り専用: true

  購買オーダー明細で源泉徴収可能な最大留保金額です。
• POLineId: integer (int64)
  購買オーダー明細を一意に識別する値。
• POLineLocationId: integer (int64)
  購買オーダー・スケジュールを一意に識別する値。
• POLineNumber: number
  タイトル: Line

  購買オーダー明細を一意に識別する番号です。
• POScheduleDescription: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  分割払いスケジュールに関連付けられた作業の摘要。
• POScheduleNumber: number
  タイトル: Schedule

  購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。
• PreviouslyApprovedAmount: number
  読取り専用: true

  現在のパフォーマンス期間前の分割払いスケジュールの承認済作業確認合計金額。
• Price: number
  タイトル: Price

  読取り専用: true

  購買オーダー・スケジュールの価格です。
• ProjectedRetainageThisPeriod: number
  読取り専用: true

  パフォーマンス期間の分割払いスケジュールで源泉徴収できる留保金額の見積。
• Quantity: number
  期間または実績の分割払いスケジュールで完了した作業の数量。
• RetainageRate: number
  タイトル: Retainage Rate

  読取り専用: true

  留保金として源泉徴収できる請求書値のパーセントです。
• ScheduledQuantity: number
  タイトル: Quantity

  読取り専用: true

  分割払い予定の予定数量。
• ScheduledValue: number
  読取り専用: true

  分割払いスケジュールのオーダー金額。
• ScheduleType: string
  タイトル: Meaning

  読取り専用: true

  最大長: 80

  分割払いスケジュールのタイプです。
• ScheduleTypeCode: string
  読取り専用: true

  最大長: 30

  分割払いスケジュール・タイプを識別する略称です。 有効な値は、レートと総額です。
• TotalCompleted: number
  読取り専用: true

  分割払いスケジュールで完了した作業の合計金額。
• TotalProgressPercent: number
  分割払いスケジュールで完了した作業のパーセントを示す値です。
• TotalProjectedRetainageToDate: number
  読取り専用: true

  分割払いスケジュールで源泉徴収できる留保金額の見積。
• UOM: string
  タイトル: UOM Name

  読取り専用: true

  最大長: 25

  購買オーダー・スケジュールでオーダーされた数量の単位です。
• UOMCode: string
  読取り専用: true

  最大長: 3

  購買オーダー・スケジュールの単位を識別する略称です。
• WorkConfirmationId: integer (int64)
  読取り専用: true

  作業確認を一意に識別する値。
• WorkConfirmationLineId: integer (int64)
  読取り専用: true

  作業確認明細を一意に識別する値。
• WorkConfirmationNumber: string
  読取り専用: true

  最大長: 30

  販売先法的エンティティの作業確認を一意に識別する番号です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the supplier or application created the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TotalProgressPercent":{
            "type":"number",
            "description":"Value that indicates the percent of the work completed on a progress payment schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the progress payment schedule type. Valid values are rate and lump sum.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Scheduled quantity of the progress payment schedule .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceToFinish":{
            "type":"number",
            "description":"Amount pending to complete the work on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCompleted":{
            "type":"number",
            "description":"Total amount of work completed on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation in a sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectedRetainageThisPeriod":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalProjectedRetainageToDate":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumRetainageAmount":{
            "title":"Maximum Retainage Amount",
            "type":"number",
            "description":"Maximum amount of retainage that can be withheld on a purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "RetainageRate":{
            "title":"Retainage Rate",
            "type":"number",
            "description":"Percentage of the invoice value that can be withheld as retainage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the quantity ordered on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Price of the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledValue":{
            "type":"number",
            "description":"Ordered amount on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviouslyApprovedAmount":{
            "type":"number",
            "description":"Total approved work confirmation amount of a progress payment schedule prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier or application most recently updated the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

添付

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/attachments

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

添付リソースは、作業確認の添付を管理します。

取消

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/action/cancel

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

承認待ちステータスから作業確認を取り消します。 取り消されると、作業確認に対してこれ以上の処理は実行できません。

documentActions

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/documentActions

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

文書処理リソースは、作業確認に対して実行された処理のリストを取得します。

行

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/lines

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

明細リソースは、パフォーマンス期間中に完了した作業の合計進捗率、数量または金額などの作業確認詳細を管理します。

飲む

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/action/submit

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

承認のために作業確認文書を送信します。 作業確認は、RESTリソースまたはユーザー・インタフェースを使用して作成できます。

取下げ

操作: /fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/action/withdraw

パラメータ:

• workConfirmationsUniqID: $request.path.workConfirmationsUniqID

承認待ちの作業確認を取り下げます。

トップに戻る

例

この例では、1つの作業確認を取得する方法を説明します。 この例では、作業確認の一意識別子を使用して1つの作業確認が取得されます。

cURLコマンドの例

この例では、作業確認の一意の識別子を使用して1つの作業確認が取得されます。

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

curl -u username:password "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationId"

たとえば:

curl -u username:password "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467"

レスポンス本文の例

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

{
    "WorkConfirmationId": 300100549276467,
    "WorkConfirmationNumber": "1005070-1",
    "POHeaderId": 300100549056643,
    "OrderNumber": "1005070",
    "SoldToLegalEntityId": 204,
    "SoldToLegalEntity": "Vision Operations",
    "PeriodStartDate": "2021-12-01",
    "PeriodEndDate": "2021-12-31",
    "WorkConfirmationRequestDate": "2022-01-03T00:00:00+00:00",
    "Comments": null,
    "StatusCode": "PENDING APPROVAL",
    "Status": "Pending Approval",
    "WorkConfirmationSequenceNumber": 1,
    "CreationDate": "2022-01-10T15:24:01+00:00",
    "CreatedBy": "CVSUPPA05",
    "LastUpdateDate": "2022-01-10T15:55:54+00:00",
    "LastUpdatedBy": "CVSUPPA05",
    "PODescription": "Contract for renovation of parking lot",
    "SupplierId": 1717,
    "Supplier": "CV_SuppA05",
    "SupplierSiteId": 4060,
    "SupplierSite": "CVSuppA05Site01",
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "ImportSource": null,
    "PreviouslyApprovedAmount": 0,
    "ContractAmountToDate": 250000,
    "TotalCompletedThisPeriod": 7000,
    "TotalCompletedToDate": 7000,
    "ProjectedRetainageThisPeriod": 700,
    "CurrentPaymentDue": 6300,
    "BalanceToFinish": 243000,
    "BuyerId": 100010026863799,
    "Buyer": "Norden,Loraine",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
            "name": "workConfirmations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
            "name": "workConfirmations",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/documentActions",
            "name": "documentActions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/withdraw",
            "name": "withdraw",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/cancel",
            "name": "cancel",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/submit",
            "name": "submit",
            "kind": "other"
        }
    ]
}

「トップに戻る」