機械翻訳について

ジャンプ先

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

セクションを取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}

リクエスト

パス・パラメータ

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

問合せパラメータ

• 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
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文( )

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

タイプ: object

ソースを表示

• Alignment: string
  最大長: 80

  整列。
• Clause: array Clauses
  タイトル: Clauses

  リソースは、契約条件の条項を表示するために使用されます。
• Description: string
  タイトル: Description

  最大長: 2000

  摘要
• Heading: string
  タイトル: Section

  最大長: 300

  見出し。
• Id: integer
  セクションの一意の識別子。
• Label: string
  最大長: 60

  ラベル。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ScnId: number
  セクションID。
• SkipNumbering: string
  最大長: 1

  スキップ採番フラグ。
• StartOnNewPage: string
  最大長: 1

  新しいページの開始フラグ。
• SubSection: array Sub Sections
  タイトル: Sub Sections

  リソースは、契約条件のサブ・セクションを表示するために使用されます。
• SuppressScnNamePrint: string
  最大長: 1

  抑制セクション名印刷フラグ。

{
    "type":"object",
    "properties":{
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"The heading.",
            "nullable":true,
            "x-queryable":true
        },
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"The alignment.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "x-queryable":true
        },
        "SubSection":{
            "title":"Sub Sections",
            "type":"array",
            "description":"The resource is used to view the sub sections of the contract terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-Section-SubSection-item-response"
            }
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"The label.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"The start on new page flag.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"The suppress section name print flag.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the section.",
            "nullable":false,
            "x-queryable":true
        },
        "Clause":{
            "title":"Clauses",
            "type":"array",
            "description":"The resource is used to view the clauses of the contract terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-Section-Clause-item-response"
            }
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"The skip numbering flag.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 条項

タイプ: array

タイトル: Clauses

リソースは、契約条件の条項を表示するために使用されます。

ソースを表示

• Array of: object contracts-Section-Clause-item-response

{
    "title":"Clauses",
    "type":"array",
    "description":"The resource is used to view the clauses of the contract terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-Section-Clause-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"
    }
}

ネストされたスキーマ : サブセクション

タイプ: array

タイトル: Sub Sections

リソースは、契約条件のサブ・セクションを表示するために使用されます。

ソースを表示

• Array of: object contracts-Section-SubSection-item-response

{
    "title":"Sub Sections",
    "type":"array",
    "description":"The resource is used to view the sub sections of the contract terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-Section-SubSection-item-response"
    }
}

ネストされたスキーマ : contracts-Section-Clause-item-response

タイプ: object

ソースを表示

• ArticleId: integer (int64)
  読取り専用: true

  条項ID。
• ArticleVersionId: number
  読取り専用: true

  条項バージョンID。
• ArticleVersionNumber: integer (int64)
  読取り専用: true

  条項バージョン番号。
• ClauseDescription: string
  読取り専用: true

  最大長: 2000

  条項の説明。
• ClauseDisplayTitle: string
  読取り専用: true

  最大長: 450

  条項の表示タイトル。
• ClauseLabel: string
  読取り専用: true

  最大長: 60

  条項ラベル。
• ClauseNumber: string
  読取り専用: true

  最大長: 240

  条項番号。
• ClauseSection: string
  読取り専用: true

  最大長: 300

  条項セクション。
• ClauseTextInHTML: 文字列(バイト)
  読取り専用: true

  HTMLの条項タイトル。
• ClauseTextInWord: 文字列(バイト)
  読取り専用: true

  Wordの条項タイトル。
• ClauseTitle: string
  読取り専用: true

  最大長: 450

  条項タイトル。
• ClauseType: string
  条項タイプ。
• ContractExpertFlag: boolean
  読取り専用: true

  最大長: 1

  契約エキスパート・フラグ。
• DocumentId: number
  読取り専用: true

  ドキュメントID。
• Id: integer (int64)
  読取り専用: true

  条項の未指定識別子。
• IncludeByReferenceFlag: boolean
  読取り専用: true

  最大長: 1

  参照による包含フラグ。
• Instructions: string
  読取り専用: true

  最大長: 2000

  条項の指示。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MajorVersion: integer (int64)
  読取り専用: true

  条項に関連付けられたメジャー・バージョンです。
• MandatoryFlag: boolean
  読取り専用: true

  最大長: 1

  必須フラグ。
• NonstandardFlag: boolean
  読取り専用: true

  最大長: 1

  非標準フラグ。
• ProtectedTextFlag: boolean
  読取り専用: true

  最大長: 1

  保護されたテキスト・フラグ。
• ScnId: number
  読取り専用: true

  セクションID。
• SkipNumberingFlag: boolean
  読取り専用: true

  最大長: 1

  スキップ採番フラグ。
• SuppressTitleFlag: boolean
  読取り専用: true

  最大長: 1

  タイトルの抑制フラグ。

{
    "type":"object",
    "properties":{
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The suppress title flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The skip numbering flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"number",
            "description":"The document ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeByReferenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The include by reference flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause title.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArticleVersionNumber":{
            "type":"integer",
            "description":"The clause version number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause display title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProtectedTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The protected text flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArticleId":{
            "type":"integer",
            "description":"The clause ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The major version associated with the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseSection":{
            "maxLength":300,
            "type":"string",
            "description":"The clause section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"The clause title in HTML.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Instructions":{
            "maxLength":2000,
            "type":"string",
            "description":"The instructions for the clause.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"The clause version ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonstandardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The non standard flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseLabel":{
            "maxLength":60,
            "type":"string",
            "description":"The clause label.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The clause number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractExpertFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The contract expert flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInWord":{
            "type":"string",
            "description":"The clause title in Word.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unqiue identifier of the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The clause description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseType":{
            "type":"string",
            "description":"The clause type.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

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

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

ネストされたスキーマ : contracts-Section-SubSection-item-response

タイプ: object

ソースを表示

• Alignment: string
  最大長: 80

  整列。
• Description: string
  タイトル: Description

  最大長: 2000

  摘要
• Heading: string
  タイトル: Section

  最大長: 300

  見出し。
• Id: integer
  セクションの一意の識別子。
• Label: string
  最大長: 60

  ラベル。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ScnId: number
  セクションID。
• SkipNumbering: string
  最大長: 1

  スキップ採番フラグ。
• StartOnNewPage: string
  最大長: 1

  新しいページの開始フラグ。
• SuppressScnNamePrint: string
  最大長: 1

  抑制セクション名印刷フラグ。

{
    "type":"object",
    "properties":{
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"The heading.",
            "nullable":true,
            "x-queryable":true
        },
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"The alignment.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"The label.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"The start on new page flag.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"The suppress section name print flag.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the section.",
            "nullable":false,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"The skip numbering flag.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

タイプ: 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/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause

パラメータ:

• SectionUniqID: $request.path.SectionUniqID
• contractsUniqID: $request.path.contractsUniqID

(条項のリソース)

SubSection

操作: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/SubSection

パラメータ:

• SectionUniqID: $request.path.SectionUniqID
• contractsUniqID: $request.path.contractsUniqID

(SubSectionのリソース)

「トップに戻る」